@nx/plugin:generator
Create a Generator for an Nx Plugin.
Usage
1nx generate generator ...
2By 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 ...
2Show what will be generated without writing to disk:
1nx g generator ... --dry-run
2Examples
Generate a generator exported with the name matching the file name. It results in the generator foo at mylib/src/generators/foo.ts:
1nx g @nx/plugin:generator mylib/src/generators/foo
2Generate a generator exported with a different name from the file name. It results in the generator custom at mylib/src/generators/foo.ts:
1nx g @nx/plugin:generator mylib/src/generators/foo --name=custom
2Options
path
Required
string
The file path to the generator without the file extension. Relative to the current working directory.
description
string
Generator description.
name
string
The generator name to export in the plugin generators collection.
skipLintChecks
boolean
Default:
falseDo not add an eslint configuration for plugin json files.
unitTestRunner
string
Default:
jestAccepted values:
jest, noneTest runner to use for unit tests.
skipFormat
Internal
boolean
Default:
falseDo not format files with prettier.