@nx/remix:storybook-configuration

Set up Storybook for a Remix library.

Usage

1nx generate storybook-configuration ... 2

By default, Nx will search for storybook-configuration in the default collection provisioned in workspace.json.

You can specify the collection explicitly as follows:

1nx g @nx/remix:storybook-configuration ... 2

Show what will be generated without writing to disk:

1nx g storybook-configuration ... --dry-run 2

Options

project

Required
string

Project for which to generate Storybook configuration.

configureStaticServe

boolean
Default: true

Specifies whether to configure a static file server target for serving storybook. Helpful for speeding up CI build/test times.

generateStories

boolean
Default: true

Automatically generate *.stories.ts files for components declared in this project?

interactionTests

configureTestRunner
boolean
Default: true

Set up Storybook interaction tests.

configureTestRunner

boolean

Add a Storybook Test-Runner target.

ignorePaths

Array<string>

Paths to ignore when looking for components.

js

boolean
Default: false

Generate JavaScript story files rather than TypeScript story files.

linter

string
Default: eslint
Accepted values: eslint

The tool to use for running lint checks.

tsConfiguration

boolean
Default: false

Configure your project with TypeScript. Generate main.ts and preview.ts files, instead of main.js and preview.js.

configureCypress

Deprecated
boolean

Run the cypress-configure generator.

Use interactionTests instead. This option will be removed in v20.

cypressDirectory

Deprecated
string

A directory where the Cypress project will be placed. Placed at the root by default.

Use interactionTests instead. This option will be removed in v20.

generateCypressSpecs

Deprecated
boolean

Automatically generate test files in the Cypress E2E app generated by the cypress-configure generator.

Use interactionTests instead. This option will be removed in v20.