nx/docs/generated/packages/react/generators/component-story.json

51 lines
1.8 KiB
JSON

{
"name": "component-story",
"factory": "./src/generators/component-story/component-story#componentStoryGenerator",
"schema": {
"$schema": "https://json-schema.org/schema",
"cli": "nx",
"$id": "NxReactComponentStory",
"title": "Create component story",
"description": "Generate storybook story for a react component.",
"type": "object",
"properties": {
"project": {
"type": "string",
"aliases": ["name", "projectName"],
"description": "The project where to add the components.",
"examples": ["shared-ui-component"],
"$default": { "$source": "projectName", "index": 0 },
"x-prompt": "What's name of the project where the component lives?",
"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?",
"x-priority": "important"
},
"skipFormat": {
"description": "Skip formatting files.",
"type": "boolean",
"default": false,
"x-priority": "internal"
},
"interactionTests": {
"type": "boolean",
"description": "Set up Storybook interaction tests.",
"default": true,
"x-priority": "important"
}
},
"required": ["project", "componentPath"],
"presets": []
},
"description": "Generate storybook story for a React component",
"hidden": false,
"implementation": "/packages/react/src/generators/component-story/component-story#componentStoryGenerator.ts",
"aliases": [],
"path": "/packages/react/src/generators/component-story/schema.json",
"type": "generator"
}