@nrwl/react:cypress-component-configuration

Add a Cypress component testing configuration to an existing project.

Usage

nx generate cypress-component-configuration ...

By default, Nx will search for cypress-component-configuration in the default collection provisioned in workspace.json.

You can specify the collection explicitly as follows:

nx g @nrwl/react:cypress-component-configuration ...

Show what will be generated without writing to disk:

nx g cypress-component-configuration ... --dry-run

Examples

Add component testing to your react project:

nx g @nrwl/react:cypress-component-configuration --project=my-react-project

Add component testing to your react project and generate component tests for your existing components:

nx g @nrwl/react:cypress-component-configuration --project=my-react-project --generate-tests

Options

buildTarget

string

Pattern: ^[^:\\s]+:[^:\\s]+(:\\S+)?$

A build target used to configure Cypress component testing in the format of project:target[:configuration]. The build target should be from a React app. If not provided we will try to infer it from your projects usage.

generateTests

boolean

Default: false

Generate default component tests for existing components in the project

project

Required

string

The name of the project to add cypress component testing configuration to

skipFormat

boolean

Default: false

Skip formatting files