@nx/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 @nx/react:stories project-name

Nx 15 and lower use @nrwl/ instead of @nx/

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 name of the project you want to generate the configuration for.
Whether you want to set up Storybook interaction tests (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..

You must provide a name for the generator to work.

By default, this generator will also set up Storybook interaction tests. If you don't want to set up Storybook interaction tests, you can pass the --interactionTests=false option, but it's not recommended.

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 @nx/react:stories --name=ui --ignorePaths=libs/ui/src/not-stories/**,**/**/src/**/*.other.*

Nx 15 and lower use @nrwl/ instead of @nx/

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.

By default, Nx will ignore the following paths:

*.stories.ts, *.stories.tsx, *.stories.js, *.stories.jsx, *.stories.mdx

but you can change this behaviour easily, as explained above.

Generate stories using JavaScript instead of TypeScript

nx g @nx/react:stories --name=ui --js=true

Nx 15 and lower use @nrwl/ instead of @nx/

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 @nx/react:stories ...

Nx 15 and lower use @nrwl/ instead of @nx/

Show what will be generated without writing to disk:

nx g stories ... --dry-run

Options

project

Required

string

Project for which to generate stories.

interactionTests

boolean

Default: true

Set up Storybook interaction tests.

cypressProject

string

The Cypress project to generate the stories under. This is inferred from project by default.

generateCypressSpecs

boolean

Automatically generate *.spec.ts files in the cypress e2e app generated by the cypress-configure generator.

ignorePaths

Array<string>

Default: [*.stories.ts,*.stories.tsx,*.stories.js,*.stories.jsx,*.stories.mdx]

Paths to ignore when looking for components.

js

boolean

Default: false

Generate JavaScript files rather than TypeScript files.

skipFormat

boolean

Default: false

Skip formatting files.