@nx/cypress/src/generators/component-configuration/schema.json

The Nx Plugin for Cypress contains executors and generators allowing your workspace to use the powerful Cypress integration testing capabilities.

{
  "$schema": "https://json-schema.org/schema",
  "$id": "NxCypressComponentConfiguration",
  "cli": "nx",
  "title": "Set up Cypress component testing for a project",
  "description": "Set up Cypress component test for a project.",
  "type": "object",
  "examples": [
    {
      "command": "nx g @nx/cypress:component-configuration --project=my-cool-lib ",
      "description": "Add cypress component testing to an existing project named my-cool-lib"
    }
  ],
  "properties": {
    "project": {
      "type": "string",
      "description": "The name of the project to add cypress component testing to",
      "$default": {
        "$source": "projectName"
      },
      "x-prompt": "What project should we add Cypress component testing to?"
    },
    "bundler": {
      "description": "The Cypress bundler to use.",
      "type": "string",
      "enum": ["vite", "webpack"],
      "x-prompt": "Which Cypress bundler do you want to use for the dev-server?",
      "default": "webpack"
    },
    "directory": {
      "type": "string",
      "description": "A directory where the project is placed relative from the project root",
      "default": "cypress"
    },
    "jsx": {
      "description": "Whether or not this project uses JSX.",
      "type": "boolean",
      "default": true
    }
  },
  "required": ["project"],
  "examplesFile": "../../../docs/cypress-component-configuration-examples.md"
}