Rescope @nrwl to @nx
@nx/pluginSee schema

@nx/plugin:executor

Create an Executor for an Nx Plugin.

Examples

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

1nx g @nx/plugin:executor build --project my-plugin 2

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

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.

directory

string

The directory at which to create the executor 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

Executor description.

includeHasher

boolean
Default: false

Should the boilerplate for a custom hasher be generated?

nameAndDirectoryFormat

string
Accepted values: as-provided, derived

Whether to generate the executor 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

Skip formatting files.

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 v20.