Package Exports

eslint-plugin-storybook

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (eslint-plugin-storybook) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

eslint-plugin-storybook

Eslint rules for Storybook Best Practices

Installation

You'll first need to install ESLint:

$ npm i eslint --save-dev

Next, install eslint-plugin-storybook:

$ npm install eslint-plugin-storybook --save-dev

Usage

Add storybook to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
    "plugins": [
        "storybook"
    ]
}

Then configure the rules you want to use under the rules section.

{
    "rules": {
        "storybook/prefer-csf": "error"
    }
}

Supported Rules

prefer-csf: Display lint message when storiesOf API is used instead of the Component Story Format