c9cac2d57a
* fix(react): pass linter option to cypress storybook setup * fix(react): add storybook linter defaults
62 lines
940 B
Markdown
62 lines
940 B
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 `angular.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
|
|
|
|
### 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: `tslint`
|
|
|
|
Type: `string`
|
|
|
|
Possible values: `eslint`, `tslint`
|
|
|
|
The tool to use for running lint checks.
|
|
|
|
### name
|
|
|
|
Type: `string`
|
|
|
|
Library name
|