diff --git a/docs/esm.md b/docs/esm.md index df952136..94d6a7b4 100644 --- a/docs/esm.md +++ b/docs/esm.md @@ -33,7 +33,7 @@ Here's a high level overview of ESM/CJS interoperability: ## Creating an ESM plugin -To generate a new ESM plugin from the [hello-world-esm template](https://github.com/oclif/hello-world-esm) run the `oclif generate` command and select `ESM` when it prompts you to select a module type: +To generate a new ESM plugin, run the `oclif generate` command and select `ESM` when it prompts you to select a module type: ``` $ npx oclif generate my-esm-plugin diff --git a/docs/examples.md b/docs/examples.md index 3e5dd1ab..2bfe5263 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -4,7 +4,7 @@ title: Examples Here are some examples to get an idea of how to use oclif in various setups. -* [Hello World Example (CommonJS)](https://github.com/oclif/hello-world) -* [Hello World Example (ESM)](https://github.com/oclif/hello-world-esm) +* [CommonJS plugin](https://github.com/oclif/test-plugin-cjs-1) +* [ESM plugin](https://github.com/oclif/plugin-test-esm-1) * [Using esbuild](https://github.com/oclif/plugin-test-esbuild) * [Hook-only plugin](https://github.com/oclif/plugin-not-found) diff --git a/docs/features.md b/docs/features.md index 562b571e..f793162f 100644 --- a/docs/features.md +++ b/docs/features.md @@ -20,11 +20,11 @@ Run a single command to scaffold out a fully functional CLI and get started quic ### Testing Helpers -We've put a lot of work into making commands easily testable and easy to mock out stdout/stderr. The generator will automatically create [scaffolded tests](https://github.com/oclif/hello-world/blob/main/test/commands/hello/world.test.ts). +We've put a lot of work into making commands easily testable and easy to mock out stdout/stderr. The generator will automatically create scaffolded tests. ### Auto-documentation -By default you can pass `--help` to the CLI to get help such as flag options and argument information. This information is also automatically placed in the README whenever the npm package of the CLI is published. See the [hello-world CLI example](https://github.com/oclif/hello-world) +By default you can pass `--help` to the CLI to get help such as flag options and argument information. This information is also automatically placed in the README whenever the npm package of the CLI is published. See the [plugin-plugins](https://github.com/oclif/plugin-plugins) as an example. ### Plugins diff --git a/docs/generator_commands.md b/docs/generator_commands.md index ec5b325e..98ad014c 100644 --- a/docs/generator_commands.md +++ b/docs/generator_commands.md @@ -12,9 +12,9 @@ Generate a new CLI ``` USAGE - $ oclif generate NAME [-y] [--author ] [--bin ] [--description ] [--license ] - [--module-type CommonJS|ESM] [--name ] [--owner ] [--package-manager npm|yarn] [--repository ] - [-d ] + $ oclif generate NAME [--author ] [--bin ] [--description ] [--license ] + [--module-type CommonJS|ESM] [--name ] [--owner ] [--package-manager npm|yarn|pnpm] [--repository + ] [-d ] [-y] ARGUMENTS NAME Directory name of new project. @@ -32,15 +32,18 @@ FLAGS --owner= Supply answer for prompt: Who is the GitHub owner of repository (https://github.com/OWNER/repo) --package-manager=