nx/docs/angular/api-storybook/generators/cypress-project.md
katerina 0c0713bdc1 chore(storybook): add "or application" to the Storybook package docs/description
Until recently we only supported Storybook configuration for libraries
now we support for apps as
well.
Some docs were out of date.
2020-12-19 14:20:27 -05:00

50 lines
754 B
Markdown

# cypress-project
Add cypress e2e app to test a ui library that is set up for storybook
## Usage
```bash
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:
```bash
nx g @nrwl/storybook:cypress-project ...
```
Show what will be generated without writing to disk:
```bash
nx g cypress-project ... --dry-run
```
## Options
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files
### linter
Default: `eslint`
Type: `string`
Possible values: `eslint`, `tslint`
The tool to use for running lint checks.
### name
Type: `string`
Library or application name