nx/docs/angular/api-react/generators/component-cypress-spec.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

52 lines
934 B
Markdown

# @nrwl/react:component-cypress-spec
Create a cypress spec for a ui component that has a story
## Usage
```bash
nx generate component-cypress-spec ...
```
By default, Nx will search for `component-cypress-spec` in the default collection provisioned in `angular.json`.
You can specify the collection explicitly as follows:
```bash
nx g @nrwl/react:component-cypress-spec ...
```
Show what will be generated without writing to disk:
```bash
nx g component-cypress-spec ... --dry-run
```
## Options
### componentPath (_**required**_)
Type: `string`
Relative path to the component file from the library root?
### project (_**required**_)
Type: `string`
The project name for which to generate tests.
### cypressProject
Type: `string`
The Cypress project to generate the stories under. By default, inferred from 'project'
### js
Default: `false`
Type: `boolean`
Generate JavaScript files rather than TypeScript files.