@nx/plugin:generator

Create a Generator for an Nx Plugin.

Usage

nx generate generator ...

By default, Nx will search for generator in the default collection provisioned in workspace.json.

You can specify the collection explicitly as follows:

nx g @nx/plugin:generator ...
Nx 15 and lower use @nrwl/ instead of @nx/

Show what will be generated without writing to disk:

nx g generator ... --dry-run

Examples

Generate libs/my-plugin/src/generators/my-generator:

nx g generator my-generator --project=my-plugin

Options

name

Required
string

Generator name.

project

pRequired
string

The name of the project.

description

d
string

Generator description.

skipLintChecks

boolean
Default: false

Do not add an eslint configuration for plugin json files.

unitTestRunner

string
Default: jest
Accepted values: jest, none

Test runner to use for unit tests.

skipFormat

boolean
Default: false

Do not format files with prettier.