nx/docs/angular/api-storybook/generators/cypress-project.md
2021-06-22 20:30:38 -04:00

64 lines
1003 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
### 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.
### name
Type: `string`
Library or application name
### standaloneConfig
Default: `false`
Type: `boolean`
Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json