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

When migrating to Nx 16, a new workspace plugin is automatically generated in the tools folder if you already have workspace-generators.

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

❯

# replace `latest` with the version that matches your Nx version

❯

npm install @nx/plugin@latest

❯

nx g @nx/plugin:plugin my-plugin

Nx 15 and lower use @nrwl/ instead of @nx/
  • 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 my-generator --project=my-plugin

Nx 15 and lower use @nrwl/ instead of @nx/

  • 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