@nx/plugin:e2e-project
Create an E2E app for a Nx Plugin.
Examples
Scaffolds an E2E project for the plugin my-plugin.
nx g @nx/plugin:e2e-project --pluginName my-plugin --npmPackageName my-plugin --pluginOutputPath dist/my-plugin
Usage
nx generate e2e-project ...
By default, Nx will search for e2e-project in the default collection provisioned in workspace.json.
You can specify the collection explicitly as follows:
nx g @nx/plugin:e2e-project ...
Show what will be generated without writing to disk:
nx g e2e-project ... --dry-run
Options
npmPackageName
Required
string
the package name of the plugin as it would be published to NPM.
pluginName
Required
string
the project name of the plugin to be tested.
pluginOutputPath
string
the output path of the plugin after it builds.
jestConfig
string
Jest config file.
linter
string
Default:
eslintAccepted values:
eslint, noneThe tool to use for running lint checks.
minimal
boolean
Default:
falseGenerate the e2e project with a minimal setup. This would involve not generating tests for a default executor and generator.
projectDirectory
string
the directory where the plugin is placed.
skipFormat
boolean
Default:
falseSkip formatting files.