https://github.com/storybookjs/eslint-config-storybook

🔗 wrapper around our @storybook/linter-config package
https://github.com/storybookjs/eslint-config-storybook

config eslint storybook

Last synced: 2 months ago
JSON representation

🔗 wrapper around our @storybook/linter-config package

• Host: GitHub
• URL: https://github.com/storybookjs/eslint-config-storybook
• Owner: storybookjs
• Created: 2019-09-26T15:37:21.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-01-15T16:43:49.000Z (about 1 year ago)
• Last Synced: 2024-10-30T00:55:27.344Z (3 months ago)
• Topics: config, eslint, storybook
• Language: JavaScript
• Homepage:
• Size: 693 KB
• Stars: 2
• Watchers: 5
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# @storybook/eslint-config-storybook

Thin wrapper around our @storybook/linter-config package, because eslint really really likes this package name for discoverability.

## Installation

You'll first need to install [ESLint](http://eslint.org):

```sh

# npm

npm install eslint --save-dev

# yarn

yarn add eslint --dev

```

Next, install `@storybook/eslint-config-storybook`:

```sh

# npm

npm install @storybook/eslint-config-storybook --save-dev

# yarn

yarn add @storybook/eslint-config-storybook --dev

```

## Usage

Add `@storybook/eslint-config-storybook` to the extends section of your `.eslintrc` configuration file.

```json

{

  "extends": ["@storybook/eslint-config-storybook"]

}

```

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

```json

{

  "rules": {

    "react/prop-types": "off"

  }

}

```