@nx/pluginSee schema

@nx/plugin:e2e-project

Create an E2E app for a Nx Plugin.

Examples

Scaffolds an E2E project for the plugin my-plugin.

1nx g @nx/plugin:e2e-project --pluginName my-plugin --npmPackageName my-plugin --pluginOutputPath dist/my-plugin 2

Usage

1nx generate e2e-project ... 2

By default, Nx will search for e2e-project in the default collection provisioned in workspace.json.

You can specify the collection explicitly as follows:

1nx g @nx/plugin:e2e-project ... 2

Show what will be generated without writing to disk:

1nx g e2e-project ... --dry-run 2

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: eslint
Accepted values: eslint, none

The tool to use for running lint checks.

minimal

boolean
Default: false

Generate 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

Internal
boolean
Default: false

Skip formatting files.