nx/docs/angular/api-storybook/generators/cypress-project.md
Craigory V Coppola a1ccc87a07
docs(misc): documentation headers should include collectionName for searchability (#6451)
Signed-off-by: AgentEnder <craigorycoppola@gmail.com>
2021-07-21 11:40:59 -04:00

1.0 KiB

@nrwl/storybook:cypress-project

Add cypress e2e app to test a ui library that is set up for storybook

Usage

nx generate cypress-project ...

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

You can specify the collection explicitly as follows:

nx g @nrwl/storybook:cypress-project ...

Show what will be generated without writing to disk:

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

Options

name (required)

Type: string

Library or application name

directory

Type: string

A directory where the project is placed

js

Default: false

Type: boolean

Generate JavaScript files rather than TypeScript files

linter

Default: eslint

Type: string

Possible values: eslint, tslint, none

The tool to use for running lint checks.

standaloneConfig

Default: false

Type: boolean

Split the project configuration into /project.json rather than including it inside workspace.json