Rescope @nrwl to @nx
@nx/pluginSee schema

@nx/plugin:generator

Create a Generator for an Nx Plugin.

Usage

1nx generate generator ... 2

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

You can specify the collection explicitly as follows:

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

Show what will be generated without writing to disk:

1nx g generator ... --dry-run 2

Examples

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

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

Options

name

Required
string

Generator name.

directory

string

The directory at which to create the generator file. When --nameAndDirectoryFormat=as-provided, it will be relative to the current working directory. Otherwise, it will be relative to the workspace root.

description

string

Generator description.

nameAndDirectoryFormat

string
Accepted values: as-provided, derived

Whether to generate the generator in the directory as provided, relative to the current working directory and ignoring the project (as-provided) or generate it using the project and directory relative to the workspace root (derived).

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

Internal
boolean
Default: false

Do not format files with prettier.

project

pDeprecated
string

The name of the project.

Provide the directory option instead and use the as-provided format. The project will be determined from the directory provided. It will be removed in Nx v19.