74 lines
2.8 KiB
JSON
74 lines
2.8 KiB
JSON
{
|
|
"name": "component-cypress-spec",
|
|
"factory": "./src/generators/component-cypress-spec/component-cypress-spec",
|
|
"schema": {
|
|
"$schema": "http://json-schema.org/schema",
|
|
"$id": "NxAngularComponentCypressSpecGenerator",
|
|
"type": "object",
|
|
"cli": "nx",
|
|
"description": "Creates a Cypress spec for a UI component that has a story.",
|
|
"properties": {
|
|
"projectName": {
|
|
"type": "string",
|
|
"description": "The name of the project.",
|
|
"examples": ["ui-samples"],
|
|
"x-priority": "important"
|
|
},
|
|
"projectPath": {
|
|
"type": "string",
|
|
"description": "Path to the project.",
|
|
"examples": ["libs/ui-samples"],
|
|
"x-priority": "important"
|
|
},
|
|
"componentName": {
|
|
"type": "string",
|
|
"description": "Class name of the component.",
|
|
"examples": ["AwesomeComponent"],
|
|
"x-priority": "important"
|
|
},
|
|
"componentPath": {
|
|
"type": "string",
|
|
"description": "Relative path to the component file from the project root.",
|
|
"examples": ["awesome"],
|
|
"x-priority": "important"
|
|
},
|
|
"componentFileName": {
|
|
"type": "string",
|
|
"description": "Component file name without the `.ts` extension.",
|
|
"examples": ["awesome.component"],
|
|
"x-priority": "important"
|
|
},
|
|
"cypressProject": {
|
|
"type": "string",
|
|
"description": "The Cypress project to generate the stories under. By default, inferred from `projectName`."
|
|
},
|
|
"specDirectory": {
|
|
"type": "string",
|
|
"description": "Directory where to place the generated spec file. By default matches the value of the `componentPath` option."
|
|
},
|
|
"skipFormat": {
|
|
"description": "Skip formatting files.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"x-priority": "internal"
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": [
|
|
"projectName",
|
|
"projectPath",
|
|
"componentName",
|
|
"componentPath",
|
|
"componentFileName"
|
|
],
|
|
"examplesFile": "## Examples\n\n{% tabs %}\n\n{% tab label=\"Basic Usage\" %}\n\nCreate a cypress spec for a component that is set up with Storybook.\n\n```bash\nnx g @nrwl/angular:component-cypress-spec --componentName=MyButtonComponent --componentPath=libs/ui/src/lib/button/button.component.ts --componentFileName=button.component --projectName=ui --projectPath=libs/ui\n```\n\n{% /tab %}\n\n{% /tabs %}\n",
|
|
"presets": []
|
|
},
|
|
"description": "Creates a Cypress spec for a UI component that has a story.",
|
|
"hidden": true,
|
|
"implementation": "/packages/angular/src/generators/component-cypress-spec/component-cypress-spec.ts",
|
|
"aliases": [],
|
|
"path": "/packages/angular/src/generators/component-cypress-spec/schema.json",
|
|
"type": "generator"
|
|
}
|