50 lines
5.8 KiB
JSON
50 lines
5.8 KiB
JSON
{
|
|
"name": "cypress-component-configuration",
|
|
"factory": "./src/generators/cypress-component-configuration/cypress-component-configuration",
|
|
"schema": {
|
|
"$schema": "https://json-schema.org/schema",
|
|
"$id": "NxAngularCypressComponentConfigurationGenerator",
|
|
"type": "object",
|
|
"cli": "nx",
|
|
"title": "Add Cypress component testing",
|
|
"description": "Add a Cypress component testing configuration to an existing project. Cypress v10.7.0 or higher is required.",
|
|
"properties": {
|
|
"project": {
|
|
"type": "string",
|
|
"description": "The name of the project to add cypress component testing configuration to",
|
|
"$default": { "$source": "projectName" },
|
|
"x-dropdown": "projects",
|
|
"x-prompt": "What project should we add Cypress component testing to?",
|
|
"x-priority": "important"
|
|
},
|
|
"generateTests": {
|
|
"type": "boolean",
|
|
"description": "Generate default component tests for existing components in the project",
|
|
"x-prompt": "Automatically generate tests for components declared in this project?",
|
|
"default": false
|
|
},
|
|
"buildTarget": {
|
|
"type": "string",
|
|
"description": "A build target used to configure Cypress component testing in the format of `project:target[:configuration]`. The build target should be an angular app. If not provided we will try to infer it from your projects usage.",
|
|
"pattern": "^[^:\\s]+:[^:\\s]+(:\\S+)?$",
|
|
"x-priority": "important"
|
|
},
|
|
"skipFormat": {
|
|
"type": "boolean",
|
|
"description": "Skip formatting files",
|
|
"default": false,
|
|
"x-priority": "internal"
|
|
}
|
|
},
|
|
"required": ["project"],
|
|
"examplesFile": "{% callout type=\"caution\" title=\"Can I use component testing?\" %}\nAngular component testing with Nx requires **Cypress version 10.7.0** and up.\n\nYou can migrate with to v10 via the [migrate-to-cypress-10 generator](/packages/cypress/generators/migrate-to-cypress-10).\n\nThis generator is for Cypress based component testing.\n\nIf you want to test components via Storybook with Cypress, then check out the [storybook-configuration generator docs](/packages/angular/generators/storybook-configuration)\n{% /callout %}\n\nThis generator is designed to get your Angular project up and running with Cypress Component Testing.\n\n```shell\nnx g @nx/angular:cypress-component-configuration --project=my-cool-angular-project\n```\n\nRunning this generator, adds the required files to the specified project with a preconfigured `cypress.config.ts` designed for Nx workspaces.\n\n```ts {% fileName=\"cypress.config.ts\" %}\nimport { defineConfig } from 'cypress';\nimport { nxComponentTestingPreset } from '@nx/angular/plugins/component-testing';\n\nexport default defineConfig({\n component: nxComponentTestingPreset(__filename),\n});\n```\n\nHere is an example on how to add custom options to the configuration\n\n```ts {% fileName=\"cypress.config.ts\" %}\nimport { defineConfig } from 'cypress';\nimport { nxComponentTestingPreset } from '@nx/angular/plugins/component-testing';\n\nexport default defineConfig({\n component: {\n ...nxComponentTestingPreset(__filename),\n // extra options here\n },\n});\n```\n\n## Specifying a Build Target\n\nComponent testing requires a _build target_ to correctly run the component test dev server. This option can be manually specified with `--build-target=some-angular-app:build`, but Nx will infer this usage from the [project graph](/concepts/mental-model#the-project-graph) if one isn't provided.\n\nFor Angular projects, the build target needs to be using the `@nx/angular:webpack-browser` or\n`@angular-devkit/build-angular:browser` executor.\nThe generator will throw an error if a build target can't be found and suggest passing one in manually.\n\nLetting Nx infer the build target by default\n\n```shell\nnx g @nx/angular:cypress-component-configuration --project=my-cool-angular-project\n```\n\nManually specifying the build target\n\n```shell\nnx g @nx/angular:cypress-component-configuration --project=my-cool-angular-project --build-target:some-angular-app:build --generate-tests\n```\n\n{% callout type=\"note\" title=\"Build Target with Configuration\" %}\nIf you're wanting to use a build target with a specific configuration. i.e. `my-app:build:production`,\nthen manually providing `--build-target=my-app:build:production` is the best way to do that.\n{% /callout %}\n\n## Auto Generating Tests\n\nYou can optionally use the `--generate-tests` flag to generate a test file for each component in your project.\n\n```shell\nnx g @nx/angular:cypress-component-configuration --project=my-cool-angular-project --generate-tests\n```\n\n## Running Component Tests\n\nA new `component-test` target will be added to the specified project to run your component tests.\n\n```shell\nnx g component-test my-cool-angular-project\n```\n\nHere is an example of the project configuration that is generated. The `--build-target` option is added as the `devServerTarget` which can be changed as needed.\n\n```json {% fileName=\"project.json\" %}\n{\n \"targets\" {\n \"component-test\": {\n \"executor\": \"@nx/cypress:cypress\",\n \"options\": {\n \"cypressConfig\": \"<path-to-project-root>/cypress.config.ts\",\n \"testingType\": \"component\",\n \"devServerTarget\": \"some-angular-app:build\",\n \"skipServe\": true\n }\n }\n }\n}\n```\n\nNx also supports [React component testing](/packages/angular/generators/cypress-component-configuration).\n",
|
|
"presets": []
|
|
},
|
|
"description": "Setup Cypress component testing for a project.",
|
|
"implementation": "/packages/angular/src/generators/cypress-component-configuration/cypress-component-configuration.ts",
|
|
"aliases": [],
|
|
"hidden": false,
|
|
"path": "/packages/angular/src/generators/cypress-component-configuration/schema.json",
|
|
"type": "generator"
|
|
}
|