57 lines
1.0 KiB
Markdown
57 lines
1.0 KiB
Markdown
---
|
|
title: '@nrwl/react:component-cypress-spec generator'
|
|
description: 'Create a cypress spec for a ui component that has a story'
|
|
---
|
|
|
|
# @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 `workspace.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.
|