nx/docs/angular/api-react/generators/storybook-configuration.md

1.3 KiB

storybook-configuration

Set up storybook for a react library

Usage

nx generate storybook-configuration ...

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

You can specify the collection explicitly as follows:

nx g @nrwl/react:storybook-configuration ...

Show what will be generated without writing to disk:

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

Options

configureCypress

Type: boolean

Run the cypress-configure generator.

cypressDirectory

Type: string

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

cypressName

Type: string

A custom name for the Cypress project. Inferred from 'name' by default.

generateCypressSpecs

Type: boolean

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

generateStories

Type: boolean

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

js

Default: false

Type: boolean

Generate JavaScript files rather than TypeScript files.

linter

Default: eslint

Type: string

Possible values: eslint, tslint

The tool to use for running lint checks.

name

Type: string

Library or application name