@nrwl/react:stories
Generate stories/specs for all components declared in a project.
This generator will generate stories for all your components in your project. The stories will be generated using Component Story Format 3 (CSF3).
nx g @nrwl/react:stories project-name
You can read more about how this generator works, in the Storybook for React overview page.
When running this generator, you will be prompted to provide the following:
- The
nameof the project you want to generate the configuration for. - Whether you want to
generateCypressSpecs. If you chooseyes, a test file is going to be generated in the project's Cypress e2e app for each of your components.
You must provide a name for the generator to work.
There are a number of other options available. Let's take a look at some examples.
Examples
Ignore certain paths when generating stories
nx g @nrwl/react:stories --name=ui --ignorePaths=libs/ui/src/not-stories/**,**/**/src/**/*.other.*
This 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.*.
This 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.
Generate stories using JavaScript instead of TypeScript
nx g @nrwl/react:stories --name=ui --js=true
This will generate stories for all the components in the ui project using JavaScript instead of TypeScript. So, you will have .stories.js files next to your components.
Usage
nx generate stories ...
By default, Nx will search for stories in the default collection provisioned in workspace.json.
You can specify the collection explicitly as follows:
nx g @nrwl/react:stories ...
Show what will be generated without writing to disk:
nx g stories ... --dry-run
Options
project
Required
string
Project for which to generate stories.
generateCypressSpecs
boolean
Automatically generate *.spec.ts files in the cypress e2e app generated by the cypress-configure generator.
cypressProject
string
The Cypress project to generate the stories under. This is inferred from project by default.
ignorePaths
Array<string>
Paths to ignore when looking for components.
js
boolean
Default:
falseGenerate JavaScript files rather than TypeScript files.
skipFormat
boolean
Default:
falseSkip formatting files.