isabella232 / eslint-config-6

A sharable ESLint configuration that enforces thoughtbot’s JavaScript guides.

thoughtbot ESLint Config

A sharable ESLint configuration that enforces thoughtbot’s JavaScript guides.

Installation

If using npm, run:

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

If using Yarn, run:

yarn add @thoughtbot/eslint-config --dev

Usage

Set your ESLint configuration to:

{
  "extends": "@thoughtbot/eslint-config"
}

You can override rules from the shared configuration, by setting your own values within the rules property:

{
  "extends": "@thoughtbot/eslint-config",
  "rules": {
    "quotes": [
      2,
      "double"
    ]
  }
}

You can also turn a rule off, by setting the value of the rule to "off":

{
  "extends": "@thoughtbot/eslint-config",
  "rules": {
    "quotes": "off"
  }
}

Atom integration

ESLint can be integrated into Atom so that you will be alerted of any warnings and errors inline, while you work.

Install the linter and linter-eslint packages using Atom’s package manager or enter this into your terminal:

apm install linter linter-eslint

License

thoughtbot ESLint Config is copyright (c) 2020 thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the LICENSE file.

About

thoughtbot ESLint Config is maintained and funded by thoughtbot, inc. The names and logos for thoughtbot are trademarks of thoughtbot, inc.

We love open source software! See our other projects or hire us to help build your product.