@nx/plugin:executor

Create an Executor for an Nx Plugin.

Usage

1nx generate executor ... 2

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

You can specify the collection explicitly as follows:

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

Show what will be generated without writing to disk:

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

Examples

Generate libs/my-plugin/src/executors/my-executor:

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

Options

name

Required
string

Executor name.

project

pRequired
string

The name of the project.

description

string

Executor description.

includeHasher

boolean
Default: false

Should the boilerplate for a custom hasher be generated?

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

Skip formatting files.