67 lines
1.1 KiB
Markdown
67 lines
1.1 KiB
Markdown
---
|
|
title: '@nrwl/storybook:cypress-project generator'
|
|
description: 'Add cypress e2e app to test a ui library that is set up for storybook'
|
|
---
|
|
|
|
# @nrwl/storybook: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 `workspace.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
|
|
|
|
### 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
|
|
|
|
Type: `boolean`
|
|
|
|
Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json
|