@nx/plugin:executor
Create an Executor for an Nx Plugin.
Examples
Create a new executor called build at tools/my-plugin/src/executors/build.ts:
1nx g @nx/plugin:executor tools/my-plugin/src/executors/build.ts
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
2Options
path
Required
string
The file path to the executor. Relative to the current working directory.
description
string
Executor description.
includeHasher
boolean
Default:
falseShould the boilerplate for a custom hasher be generated?
name
string
The executor name to export in the plugin executors collection.
skipLintChecks
boolean
Default:
falseDo not add an eslint configuration for plugin json files.
unitTestRunner
string
Default:
jestAccepted values:
jest, vitest, noneTest runner to use for unit tests.
skipFormat
Internal
boolean
Default:
falseSkip formatting files.