@nrwl/cypress:cypress-project

Create Cypress Configuration for the workspace.

Usage

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:

nx g @nrwl/cypress:cypress-project ...

Show what will be generated without writing to disk:

nx g cypress-project ... --dry-run

Options

baseUrl

string

The address (with the port) which your application is running on.

directory

string

A directory where the project is placed.

js

boolean
Default: false

Generate JavaScript files rather than TypeScript files.

linter

string
Default: eslint
Accepted values: eslint, tslint, none

The tool to use for running lint checks.

name

Required
string

Name of the E2E Project.

project

string

The name of the frontend project to test.

skipFormat

boolean
Default: false

Skip formatting files.

setParserOptionsProject

boolean
Default: false

Whether or not to configure the ESLint parserOptions.project option. We do not do this by default for lint performance reasons.

standaloneConfig

boolean

Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json.

skipPackageJson

boolean
Default: false

Do not add dependencies to package.json.