docs(misc): update generator examples to use new directory/path positional args (#28144 )

This PR updates examples in `.md` files (both docs and blog posts) to
use positional args. Nx 20 changes the position arg to be either
`directory` for apps/libs or `path` for artifacts (e.g. components).

So before you'd do this:

```
nx g app myapp --directory=apps/myapp
nx g lib mylib --directory=libs/mylib
nx g lib mylib --directory=libs/nested/mylib
nx g lib @acme/foo --directory=libs/@acme/foo --importPath=@acme/foo
nx g component foo --directory=libs/ui/src/foo --pascalCaseFiles
```

Will now be simplified to

```
nx g app apps/myapp
nx g lib libs/mylib
nx g lib libs/nested/mylib
nx g lib libs/@acme/foo # name and import path are both "@acme/foo"
nx g component libs/ui/src/foo/Foo
```

For cases where `name` and `importPath` need to be changed, you can
always manually specify them.

```
nx g lib libs/nested/foo # name is foo
nx g lib libs/nested/foo --name=nested-foo # specify name with prefix
nx g lib libs/@acme/foo --name # use "foo" as name and don't match importPath
nx g lib libs/@internal/foo --importPath=@acme/foo # different importPath from name

<!-- If this is a particularly complex change or feature addition, you can request a dedicated Nx release for this pull request branch. Mention someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they will confirm if the PR warrants its own release for testing purposes, and generate it for you if appropriate. -->

## Current Behavior
<!-- This is the behavior we have today -->

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR -->

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is merged. -->

Fixes #

2024-09-30 13:20:10 -04:00

1.4 KiB

Raw Blame History

Workspace Generators

In Nx 13.10, we introduced the ability to run generators from Nx plugins in the workspace they were created in.

By using a "local" plugin, you can set the plugin as your workspace's default collection and get several other affordances that are not provided to workspace generators. This is the preferred method for "workspace generators", and existing generators will eventually be transitioned to use a local plugin.

Check the local generator guide for information on creating a new plugin.

Converting workspace generators to local generators

{% callout type="info" %} When migrating to Nx 16, a new workspace plugin is automatically generated in the tools folder if you already have workspace-generators. {% /callout %}

If you don't already have a local plugin, use Nx to generate one:

npm add -D @nx/plugin
nx g @nx/plugin:plugin tools/my-plugin

Use the Nx CLI to generate the initial files needed for your generator. Replace my-generator with the name of your workspace generator.

nx generate @nx/plugin:generator tools/my-plugin/src/generators/my-generator

Copy the code for your workspace generator into the newly created generator's folder. e.g. libs/my-plugin/src/generators/my-generator/
Now you can run the generator like this:

nx g my-generator

1.4 KiB Raw Blame History

Workspace Generators

Converting workspace generators to local generators

1.4 KiB

Raw Blame History