9efa305b62
* feat(storybook): storybook config projectType application * docs(storybook): update auto-generated docs * feat(storybook): supporting projectType application for storybook feat(storybook): supporting projectType application for storybook * fix(storybook): change build asset glob pattern fix(storybook): change build asset glob pattern Co-authored-by: Webber Wang <webber@codelabstudios.com>
68 lines
1.1 KiB
Markdown
68 lines
1.1 KiB
Markdown
# storybook-configuration
|
|
|
|
Set up storybook for a react library
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
nx generate storybook-configuration ...
|
|
```
|
|
|
|
By default, Nx will search for `storybook-configuration` in the default collection provisioned in `workspace.json`.
|
|
|
|
You can specify the collection explicitly as follows:
|
|
|
|
```bash
|
|
nx g @nrwl/react:storybook-configuration ...
|
|
```
|
|
|
|
Show what will be generated without writing to disk:
|
|
|
|
```bash
|
|
nx g storybook-configuration ... --dry-run
|
|
```
|
|
|
|
## Options
|
|
|
|
### configureCypress
|
|
|
|
Type: `boolean`
|
|
|
|
Run the cypress-configure schematic.
|
|
|
|
### generateCypressSpecs
|
|
|
|
Type: `boolean`
|
|
|
|
Automatically generate \*.spec.ts files in the cypress e2e app generated by the cypress-configure schematic
|
|
|
|
### 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
|