@nrwl/cypressSee schema
Schema for internal use only

Please do not extend this schema as it is part of Nx internal usage.

@nrwl/cypress:cypress-project

Create Cypress Configuration for the workspace.

Adding Cypress to an existing application requires two options. The name of the e2e app to create and what project that e2e app is for.

nx g cypress-project --name=my-app-e2e --project=my-app

When providing --project option, the generator will look for the serve target in that given project. This allows the cypress executor to spin up the project and start the cypress runner.

If you prefer to not have the project served automatically, you can provide a --base-url argument in place of --project

nx g cypress-project --name=my-app-e2e --base-url=http://localhost:1234
What about API Projects?

You can also run the cypress-project generator against API projects like a Nest API. If there is a URL to visit then you can test it with Cypress!

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, 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.

rootProject

Hidden
boolean
Default: false

Create a application at the root of the workspace

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.