Skip to content

Commit

Permalink
feat: add more precisions in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MarioArnt committed Jan 16, 2024
1 parent 8528fab commit 2466f4d
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
# Robespierre

Robespierre is a tool built in RUST and packaged via NPM that helps you find extraneous and implicit dependencies by
comparing your manifest and actual imports in your code using AST parsing.
comparing your manifest and actual imports in your **typescript** code using AST parsing.

* An *extraneous* dependency is a dependency declared in you `package.json` manifest, but unused in you code
* An *implicit* dependency is the opposite. A dependecy used somewhere in your codebase via an import statement, but not declared in your `package.json`. It can work somehow, 'cause it's installed indirectly by another dependency, but this is a bad practice.

Robespierre is focused on performance and uses [SWC](https://github.com/swc-project/swc) typescript AST parser to browse your codebase efficiently.

> The name "robespierre" is a humorous reference to Maximilien de Robespierre, a significant political figure in the French Revolution. Known for prolifically using the guillotine, our binary borrows its name because it helps you figure out which dependency's head to cut off!
## Installation

Expand Down Expand Up @@ -45,4 +52,4 @@ You can then wrap the binary (by using bash):

```bash
./package.sh
```
```

0 comments on commit 2466f4d

Please sign in to comment.