@nx/plugin:executor

Create an Executor for an Nx Plugin.

Examples

Create a new executor called build inside the plugin my-plugin:

nx g @nx/plugin:executor tools/my-plugin/src/executors/build

Usage

nx generate executor ...

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

You can specify the collection explicitly as follows:

nx g @nx/plugin:executor ...

Show what will be generated without writing to disk:

nx g executor ... --dry-run

Examples

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

nx g executor libs/my-plugin/src/executors/my-executor

Options

path

Required

string

The file path to the executor without the file extension (e.g. my-plugin/src/executors/my-executor generates the file my-plugin/src/executors/my-executor.ts). Relative to the current working directory.

description

string

Executor description.

includeHasher

boolean

Default: false

Should the boilerplate for a custom hasher be generated?

name

string

The executor name to export in the plugin executors collection.

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

Skip formatting files.