8290969cb7
- feat(storybook): remove cypress options from configuration generator - feat(react): remove cypress options from storybook-configuration - feat(react): remove cypress options from stories generator - feat(react): remove component-cypress-spec generator - chore(storybook): restore @nx/cypress dep - feat(remix): remove cypress options from storybook - feat(angular): remove cypress options from storybook-configuration - feat(angular): remove cypress options from stories generator - feat(angular): remove component-cypress-spec generator - feat(vue): remove cypress options from stories generator <!-- Please make sure you have read the submission guidelines before posting an PR --> <!-- https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr --> <!-- Please make sure that your commit message follows our format --> <!-- Example: `fix(nx): must begin with lowercase` --> <!-- If this is a particularly complex change or feature addition, you can request a dedicated Nx release for this pull request branch. Mention someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they will confirm if the PR warrants its own release for testing purposes, and generate it for you if appropriate. --> ## Current Behavior <!-- This is the behavior we have today --> With Storybook Interaction Testing, there's no longer a need to setup Cypress to specifically test storybook instances ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> Remove cypress options for creating an e2e project specifically for testing storybook instances. Use Storybook Interaction Testing instead ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes #
62 lines
4.3 KiB
JSON
62 lines
4.3 KiB
JSON
{
|
|
"name": "stories",
|
|
"factory": "./src/generators/stories/stories",
|
|
"schema": {
|
|
"$schema": "https://json-schema.org/schema",
|
|
"$id": "NxAngularStorybookStoriesGenerator",
|
|
"title": "Create Storybook stories/specs",
|
|
"description": "Creates Storybook stories/specs for all Angular components declared in a project.",
|
|
"cli": "nx",
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string",
|
|
"aliases": ["project", "projectName"],
|
|
"description": "Project for which to generate stories.",
|
|
"$default": { "$source": "argv", "index": 0 },
|
|
"x-prompt": "What's the name of the project for which you want to generate stories?",
|
|
"x-dropdown": "projects",
|
|
"x-priority": "important"
|
|
},
|
|
"interactionTests": {
|
|
"type": "boolean",
|
|
"description": "Set up Storybook interaction tests.",
|
|
"x-prompt": "Do you want to set up Storybook interaction tests?",
|
|
"x-priority": "important",
|
|
"default": true
|
|
},
|
|
"skipFormat": {
|
|
"description": "Skip formatting files.",
|
|
"type": "boolean",
|
|
"default": false,
|
|
"x-priority": "internal"
|
|
},
|
|
"ignorePaths": {
|
|
"type": "array",
|
|
"description": "Paths to ignore when looking for components.",
|
|
"items": { "type": "string", "description": "Path to ignore." },
|
|
"default": [
|
|
"*.stories.ts,*.stories.tsx,*.stories.js,*.stories.jsx,*.stories.mdx"
|
|
],
|
|
"examples": [
|
|
"apps/my-app/src/not-stories/**",
|
|
"**/**/src/**/not-stories/**",
|
|
"libs/my-lib/**/*.something.ts",
|
|
"**/**/src/**/*.other.*",
|
|
"libs/my-lib/src/not-stories/**,**/**/src/**/*.other.*,apps/my-app/**/*.something.ts"
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false,
|
|
"required": ["name"],
|
|
"examplesFile": "This generator will generate stories for all your components in your project. The stories will be generated using [Component Story Format 3 (CSF3)](https://storybook.js.org/blog/storybook-csf3-is-here/).\n\n```bash\nnx g @nx/angular:stories project-name\n```\n\nYou can read more about how this generator works, in the [Storybook for Angular overview page](/recipes/storybook/overview-angular#auto-generate-stories).\n\nWhen running this generator, you will be prompted to provide the following:\n\n- The `name` of the project you want to generate the configuration for.\n- Whether you want to set up [Storybook interaction tests](https://storybook.js.org/docs/angular/writing-tests/interaction-testing) (`interactionTests`). If you choose `yes`, a `play` function will be added to your stories, and all the necessary dependencies will be installed. You can read more about this in the [Nx Storybook interaction tests documentation page](/recipes/storybook/storybook-interaction-tests#setup-storybook-interaction-tests).\n\nYou must provide a `name` for the generator to work.\n\nBy default, this generator will also set up [Storybook interaction tests](https://storybook.js.org/docs/angular/writing-tests/interaction-testing). If you don't want to set up Storybook interaction tests, you can pass the `--interactionTests=false` option, but it's not recommended.\n\nThere are a number of other options available. Let's take a look at some examples.\n\n## Examples\n\n### Ignore certain paths when generating stories\n\n```bash\nnx g @nx/angular:stories ui --ignorePaths=libs/ui/src/not-stories/**,**/**/src/**/*.other.*\n```\n\nThis will generate stories for all the components in the `ui` project, except for the ones in the `libs/ui/src/not-stories` directory, and also for components that their file name is of the pattern `*.other.*`.\n\nThis is useful if you have a project that contains components that are not meant to be used in isolation, but rather as part of a larger component.\n\nBy default, Nx will ignore the following paths:\n\n```text\n*.stories.ts, *.stories.tsx, *.stories.js, *.stories.jsx, *.stories.mdx\n```\n\nbut you can change this behaviour easily, as explained above.\n",
|
|
"presets": []
|
|
},
|
|
"description": "Creates stories/specs for all components declared in a project.",
|
|
"implementation": "/packages/angular/src/generators/stories/stories.ts",
|
|
"aliases": [],
|
|
"hidden": false,
|
|
"path": "/packages/angular/src/generators/stories/schema.json",
|
|
"type": "generator"
|
|
}
|