@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
2Usage
1nx generate executor ...
2By 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 ...
2Show what will be generated without writing to disk:
1nx g executor ... --dry-run
2Examples
Generate libs/my-plugin/src/executors/my-executor:
1nx g executor my-executor --project=my-plugin
2Options
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:
falseShould the boilerplate for a custom hasher be generated?
nameAndDirectoryFormat
string
Accepted values:
as-provided, derivedWhether 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:
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:
falseSkip 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 v19.