81 lines
1.3 KiB
Markdown
81 lines
1.3 KiB
Markdown
---
|
|
title: '@nrwl/storybook:configuration generator'
|
|
description: 'Add storybook configuration to a ui library or an application'
|
|
---
|
|
|
|
# @nrwl/storybook:configuration
|
|
|
|
Add storybook configuration to a ui library or an application
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
nx generate configuration ...
|
|
```
|
|
|
|
By default, Nx will search for `configuration` in the default collection provisioned in `angular.json`.
|
|
|
|
You can specify the collection explicitly as follows:
|
|
|
|
```bash
|
|
nx g @nrwl/storybook:configuration ...
|
|
```
|
|
|
|
Show what will be generated without writing to disk:
|
|
|
|
```bash
|
|
nx g configuration ... --dry-run
|
|
```
|
|
|
|
## Options
|
|
|
|
### name (_**required**_)
|
|
|
|
Type: `string`
|
|
|
|
Library or application name
|
|
|
|
### configureCypress
|
|
|
|
Type: `boolean`
|
|
|
|
Run the cypress-configure generator
|
|
|
|
### cypressDirectory
|
|
|
|
Type: `string`
|
|
|
|
A directory where the Cypress project will be placed. Added at root by default.
|
|
|
|
### js
|
|
|
|
Default: `false`
|
|
|
|
Type: `boolean`
|
|
|
|
Generate JavaScript files rather than TypeScript files
|
|
|
|
### linter
|
|
|
|
Default: `eslint`
|
|
|
|
Type: `string`
|
|
|
|
Possible values: `eslint`, `tslint`, `none`
|
|
|
|
The tool to use for running lint checks.
|
|
|
|
### standaloneConfig
|
|
|
|
Type: `boolean`
|
|
|
|
Split the project configuration into <projectRoot>/project.json rather than including it inside workspace.json
|
|
|
|
### uiFramework
|
|
|
|
Type: `string`
|
|
|
|
Possible values: `@storybook/angular`, `@storybook/react`
|
|
|
|
Storybook UI Framework to use
|