nx/docs/generated/packages/react/generators/component-cypress-spec.json

53 lines
2.0 KiB
JSON

{
"name": "component-cypress-spec",
"factory": "./src/generators/component-cypress-spec/component-cypress-spec#componentCypressGenerator",
"schema": {
"$schema": "http://json-schema.org/schema",
"cli": "nx",
"$id": "NxReactComponentCypressSpec",
"title": "Create component Cypress spec",
"description": "Create a Cypress spec for a UI component that has a story.",
"type": "object",
"properties": {
"project": {
"type": "string",
"description": "The project name for which to generate tests.",
"examples": ["shared-ui-component"],
"$default": { "$source": "projectName", "index": 0 },
"x-prompt": "What's name of the project for which to generate tests?",
"x-priority": "important"
},
"componentPath": {
"type": "string",
"description": "Relative path to the component file from the library root?",
"examples": ["lib/components"],
"x-prompt": "What's path of the component relative to the project's lib root for which to generate a test?",
"x-priority": "important"
},
"js": {
"type": "boolean",
"description": "Generate JavaScript files rather than TypeScript files.",
"default": false
},
"cypressProject": {
"type": "string",
"description": "The Cypress project to generate the stories under. By default, inferred from `project`."
},
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false,
"x-priority": "internal"
}
},
"required": ["project", "componentPath"],
"presets": []
},
"description": "Create a Cypress spec for a UI component that has a story.",
"hidden": false,
"implementation": "/packages/react/src/generators/component-cypress-spec/component-cypress-spec#componentCypressGenerator.ts",
"aliases": [],
"path": "/packages/react/src/generators/component-cypress-spec/schema.json",
"type": "generator"
}