@nx/cypress:component-configuration
Set up Cypress component test for a project.
Schema for internal use only
Please do not extend this schema as it is part of Nx internal usage.
This is a framework-agnostic generator for adding component testing to a project.
nx g cypress-component-configuration --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-configuration 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
Usage
nx generate component-configuration ...
nx g cypress-component-configuration ... #same
By default, Nx will search for component-configuration in the default collection provisioned in workspace.json.
You can specify the collection explicitly as follows:
nx g @nx/cypress:component-configuration ...
Show what will be generated without writing to disk:
nx g component-configuration ... --dry-run
Examples
Add cypress component testing to an existing project named my-cool-lib:
nx g @nx/cypress:component-configuration --project=my-cool-lib
Options
project
Required
string
The name of the project to add cypress component testing to
bundler
string
Default:
webpackAccepted values:
vite, webpackThe Cypress bundler to use.
directory
string
Default:
cypressA directory where the project is placed relative from the project root