@nrwl/cypress:cypress

Cypress target option for Build Facade.

Options can be configured in project.json when defining the executor, or when invoking it. Read more about how to configure targets and executors here: https://nx.dev/configuration/projectjson#targets.

Options playground

Try out this interactive editor of the configuration object. Values are validated as you type and hovering over labels will give you more information.

Options

baseUrl

string

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

browser

string

The browser to run tests in.

cypressConfig

Required

string

The path of the Cypress configuration json file.

copyFiles

Deprecated

string

A regex string that is used to choose what additional integration files to copy to the dist folder.

ciBuildId

oneOf [string, number]

A unique identifier for a run to enable grouping or parallelization.

devServerTarget

string

Dev server target to run tests against.

exit

boolean

Default: true

Whether or not the Cypress Test Runner will stay open after running tests in a spec file.

env

A key-value Pair of environment variables to pass to Cypress runner.

group

string

A named group for recorded runs in the Cypress dashboard.

headed

boolean

Default: false

Displays the browser instead of running headlessly. Set this to true if your run depends on a Chrome extension being loaded.

headless

Deprecated

boolean

Default: false

Hide the browser instead of running headed (default for cypress run).

ignoreTestFiles

string

A String or Array of glob patterns used to ignore test files that would otherwise be shown in your list of tests. Cypress uses minimatch with the options: {dot: true, matchBase: true}. We suggest using https://globster.xyz to test what files would match.

key

string

The key cypress should use to run tests in parallel/record the run (CI only).

parallel

boolean

Default: false

Whether or not Cypress should run its tests in parallel (CI only).

record

boolean

Default: false

Whether or not Cypress should record the results of the tests.

reporter

string

The reporter used during cypress run.

reporterOptions

string

The reporter options used. Supported options depend on the reporter.

spec

string

A comma delimited glob string that is provided to the Cypress runner to specify which spec files to run. i.e. **examples/**,**actions.spec**.

skipServe

boolean

Default: false

Skip dev-server build.

tsConfig

string

The path of the Cypress tsconfig configuration json file.

testingType

string

Default: e2e

Accepted values: component, e2e

Specify the type of tests to execute.

tag

string

A comma delimited list to identify a run with.

watch

boolean

Default: false

Recompile and run tests when files change.

Additional Properties

anything

Extra properties of any type may be provided to this object.