refactor: replace subcommands with arguments (#36)

## Description This PR significantly reduces the runtime duration of the CLI. This is achieved by using a single CLI argument instead of subcommands. While subcommands might be nicer for user experience, they are quite slow in execution.
faker-js · Dec 20, 2023 · 4bd2f5d · 4bd2f5d
1 parent cdb57e1
commit 4bd2f5d
Show file tree

Hide file tree

Showing 282 changed files with 84 additions and 3,344 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 A CLI of [@faker-js/faker](https://github.com/faker-js/faker).
 
-> **Note**: This is currently a [MVP](https://en.wikipedia.org/wiki/Minimum_viable_product).
+> **:information_source: Note**: This is currently a [MVP](https://en.wikipedia.org/wiki/Minimum_viable_product).
 
 ## Install
 
@@ -13,27 +13,55 @@ npm install --save-dev @faker-js/cli
 ## Usage
 
 ```
-faker module_name method_name
+npx faker <moduleName> <functionName>
 ```
 
-Faker-CLI expects a `module_name` as well as a `method_name` depending on the module chosen.
+> **:information_source: Note**: [Read more about `npx`](https://docs.npmjs.com/cli/v7/commands/npx)
 
-To list all possible modules run:
+Faker-CLI expects a `moduleName` as well as a `functionName` argument.
+This is equivalent to calling `faker[moduleName][functionName]`.
+Checkout [Fakers's API](https://fakerjs.dev/api/) for information on which modules and functions are available.
+
+## Examples
+
+If you want a integer you can run:
 
 ```bash
-faker --help
+npx faker number int
 ```
 
-To list all possible methods of a module run:
+## What's Next?
+
+Upcoming features might include:
+
+### :hammer_and_wrench: Localization
+
+Users will be able to specify a locale for localized data.
+Currently, the CLI always uses the default `en` locale.
+In the future, this feature could be implemented as follows:
 
 ```bash
-faker module_name --help
+npx faker --locale de person firstName
 ```
 
-## Whats next
+This example would print a first name from the German locale.
 
-Upcoming features might include:
+### :hammer_and_wrench: Support for All Parameters of `@faker-js/faker` Natively
+
+This CLI is currently in its MVP stage, which means that it only performs the bare minimum.
+If you need an integer within a specific range, you'll have to do it yourself.
+In the future, this feature could be implemented as follows:
+
+```bash
+npx faker number int --min 10 --max 20
+```
+
+This example will generate an integer between 10 and 20.
+The `min` and `max` options are available in [Faker's int options](https://fakerjs.dev/api/number.html#int).
+
+### :hammer_and_wrench: Better Documentation in the Terminal
 
-- localization
-- support for all parameters `@faker-js/faker` natively
-- make the CLI consumable for your own modules
+Developers often dislike changing work environments.
+If you're already working in the terminal, you probably don't want to leave it to look up a small detail.
+Instead, you expect the CLI to have a proper `--help` documentation that includes examples.
+This will be the case in the future.
diff --git a/src/commands/airline/aircraftType.ts b/src/commands/airline/aircraftType.ts
diff --git a/src/commands/airline/airline.ts b/src/commands/airline/airline.ts
diff --git a/src/commands/airline/airplane.ts b/src/commands/airline/airplane.ts
diff --git a/src/commands/airline/airport.ts b/src/commands/airline/airport.ts
diff --git a/src/commands/airline/flightNumber.ts b/src/commands/airline/flightNumber.ts
diff --git a/src/commands/airline/index.ts b/src/commands/airline/index.ts
diff --git a/src/commands/airline/recordLocator.ts b/src/commands/airline/recordLocator.ts
diff --git a/src/commands/airline/seat.ts b/src/commands/airline/seat.ts
diff --git a/src/commands/animal/bear.ts b/src/commands/animal/bear.ts
diff --git a/src/commands/animal/bird.ts b/src/commands/animal/bird.ts
diff --git a/src/commands/animal/cat.ts b/src/commands/animal/cat.ts
diff --git a/src/commands/animal/cetacean.ts b/src/commands/animal/cetacean.ts
diff --git a/src/commands/animal/cow.ts b/src/commands/animal/cow.ts
diff --git a/src/commands/animal/crocodilia.ts b/src/commands/animal/crocodilia.ts
diff --git a/src/commands/animal/dog.ts b/src/commands/animal/dog.ts
diff --git a/src/commands/animal/fish.ts b/src/commands/animal/fish.ts
diff --git a/src/commands/animal/horse.ts b/src/commands/animal/horse.ts
diff --git a/src/commands/animal/index.ts b/src/commands/animal/index.ts
diff --git a/src/commands/animal/insect.ts b/src/commands/animal/insect.ts
diff --git a/src/commands/animal/lion.ts b/src/commands/animal/lion.ts
diff --git a/src/commands/animal/rabbit.ts b/src/commands/animal/rabbit.ts
diff --git a/src/commands/animal/rodent.ts b/src/commands/animal/rodent.ts
diff --git a/src/commands/animal/snake.ts b/src/commands/animal/snake.ts
diff --git a/src/commands/animal/type.ts b/src/commands/animal/type.ts
diff --git a/src/commands/color/cmyk.ts b/src/commands/color/cmyk.ts
diff --git a/src/commands/color/colorByCSSColorSpace.ts b/src/commands/color/colorByCSSColorSpace.ts