Schema for internal use only

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


Set up Cypress component test for a project.

This is a framework-agnostic generator for adding component testing to a project.

nx g cypress-component-project --project=my-cool-project

Running this generator, adds the required files to the specified project without any configurations for Cypress. It's best to use the framework specific generator, instead cypress-component-project directly

A new component-test target will be added to the specified project.

nx g component-test my-cool-project

Read more about Cypress Component Testing


nx generate cypress-component-project ...

By default, Nx will search for cypress-component-project in the default collection provisioned in workspace.json.

You can specify the collection explicitly as follows:

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

Show what will be generated without writing to disk:

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


Add cypress component testing to an existing project named my-cool-lib:

nx g @nrwl/cypress:cypress-component-project --project=my-cool-lib




The name of the project to add cypress component testing to


Default: webpack
Accepted values: vite, webpack

The Cypress bundler to use.