@nx/storybookSee schema
Deprecated

Deprecated: Use 'interactionTests' instead when running '@nx/storybook:configuration'. This generator will be removed in v21.

@nx/storybook:cypress-project

Add cypress E2E app to test a ui library that is set up for Storybook.

Usage

1nx generate cypress-project ... 2

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

You can specify the collection explicitly as follows:

1nx g @nx/storybook:cypress-project ... 2

Show what will be generated without writing to disk:

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

Options

name

Required
string

Project for which to generate the cypress E2E app.

directory

string

A directory where the project is placed.

js

boolean
Default: false

Generate JavaScript files rather than TypeScript files.

linter

string
Default: eslint
Accepted values: eslint, none

The tool to use for running lint checks.

ciTargetName

Internal
string

The name of the devServerTarget to use for the Cypress CI configuration. Used to control if using <storybook-project>:static-storybook:ci or <storybook-project>:storybook:ci

skipFormat

Internal
boolean
Default: false

Skip formatting files.