@thibaudcolas/eslint-plugin-cookbook

Shareable ESLint config, based on airbnb/javascript, bundled as a plugin.

Why

We want shareable configs to have as low of an overhead as possible. Users shouldn't have to know exactly what plugins are required by the config, install them and manage their versions manually. This plugin contains a shareable config, with plugin dependencies automatically installed.

See https://github.com/eslint/eslint/issues/3458 for further discussion on this topic.

Usage

Install ESLint and the config:

npm install --save-dev eslint @thibaudcolas/eslint-plugin-cookbook

Then configure ESLint to use this config. As a .eslintrc.js in the root of your project:

module.exports = {
  // https://github.com/thibaudcolas/eslint-plugin-cookbook
  extends: "plugin:@thibaudcolas/cookbook/recommended",
};

With Prettier

This recommended config is Prettier-compatible. First, install Prettier:

npm install --save-dev prettier

Then, to configure Prettier itself, create a prettier.config.js file in the root of your project. You can use the following to get started:

// https://github.com/thibaudcolas/eslint-plugin-cookbook
module.exports = require("@thibaudcolas/eslint-plugin-cookbook/prettier.config");

Switching to this config

Read on: Upgrading to a stricter ESLint config.

Overriding the rules

Should further customisation be required, rules coming from external plugins require the @thibaudcolas/cookbook prefix:

module.exports = {
  // https://github.com/thibaudcolas/eslint-plugin-cookbook
  extends: "plugin:@thibaudcolas/cookbook/recommended",
  rules: {
-    "react/react-in-jsx-scope": ["warn"],
+    "@thibaudcolas/cookbook/react/react-in-jsx-scope": ["warn"],
-    "import/prefer-default-export": ["warn"],
+    "@thibaudcolas/cookbook/import/prefer-default-export": ["warn"],
  },
};

Tips

• Use ESLint’s --report-unused-disable-directives flag to ensure you do not use more eslint-disable comments than needed.

Related tools

To get the most out of this config, it is assumed that projects have the following tools set up:

• Prettier for automated formatting of stylesheets.
• Browserslist for the definition of target browsers (along with autoprefixer and @babel/preset-env).

Rules

Extends

• airbnb
• prettier
• prettier/react
• prettier/flowtype

Cookbook config

• no-warning-comments: 1, terms: todo, fixme, xxx, location: start
• import/no-extraneous-dependencies: 2, devDependencies: test/**, tests/**, spec/**, **/__tests__…
• react/jsx-filename-extension: 2, extensions: .js
• no-param-reassign: 2, props: false
• react/forbid-prop-types: 2, forbid: any

Rules of airbnb

Disabled rules

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning, enforced with semantic-release.

6.0.0 (2020-06-03)

Features

• config: update all config dependencies, with major updates (6c893b9)
• deps: open ESLint peerDependency range to any version above 5.6.0 (a5239e7)

BREAKING CHANGES

• config: this updates all configs/plugins this package is based on, as well as supporting ESLint 7. Please refer to the table below:

5.0.1 (2019-09-02)

Bug Fixes

• readme: document which configs this package extends from (e10c09c)
• readme: re-add missing tips section in README (1b9dfce)

5.0.0 (2019-09-02)

Features

• config: reenable jsx-a11y label rules (7fcf0e3)
• config: update all config dependencies, with major updates (96f2214)

BREAKING CHANGES

• config: we’ve re-enabled label-related rules from jsx-a11y. They seem to be more reliable than they have been in the past.
• config: this updates all configs/plugins this package is based on, as well as supporting ESLint 6. Please refer to the table below:

Additionally, eslint-plugin-react-hooks has been added to enforce the rules of hooks.

4.0.1 (2018-09-22)

Bug Fixes

• release: upgrade lodash transitive dependency to fix vulnerability (5a19da2)

4.0.0 (2018-09-22)

Features

• config: cleanup config rules (b046648)
• config: export only the Prettier-compatible config (b5473ce)
• config: remove Prettier plugin (4d3574d)

BREAKING CHANGES

• config: Updates how rules are configred in the config, generally to be stricter. Here are the detailed changes:

"import/no-extraneous-dependencies": Array [
  2,
  Object {
-     "devDependencies": true,
+     "devDependencies": Array [
+       "test/**",
+       "tests/**",
+       "spec/**",
+       "**/__tests__/**",
+       "**/__mocks__/**",
+       "test.{js,jsx}",
+       "test-*.{js,jsx}",
+       "**/*{.,_}{test,spec}.{js,jsx}",
+       "**/jest.config.js",
+       "**/vue.config.js",
+       "**/webpack.config.js",
+       "**/webpack.config.*.js",
+       "**/rollup.config.js",
+       "**/rollup.config.*.js",
+       "**/gulpfile.js",
+       "**/gulpfile.*.js",
+       "**/Gruntfile{,.js}",
+       "**/protractor.conf.js",
+       "**/protractor.conf.*.js",
+       "**/dangerfile.js",
+    ],
  },
],

- "import/prefer-default-export": "off",
+ "import/prefer-default-export": "error",

- "jsx-a11y/label-has-associated-control": "error",
+ "jsx-a11y/label-has-associated-control": "off",

- "react/jsx-boolean-value": "off",
+ "react/jsx-boolean-value": "error",

- "react/jsx-indent": "error",
+ "react/jsx-indent": "off",

- "react/jsx-indent-props": "error",
+ "react/jsx-indent-props": "off",

- "react/sort-comp": "off",
+ "react/sort-comp": "error",

- "arrow-body-style": "off",
+ "arrow-body-style": "error",

- "eol-last": "warn",
+ "eol-last": "off",

- "id-length": "off",
+ "id-length": "off",

- "indent": "error",
+ "indent": "off",

- "jsx-quotes": "warn"
+ "jsx-quotes": "off"

- "max-len": "warn"
+ "max-len": "off"

"no-console": Array [
    "warn",
-   Object {
-     "allow": Array [
-       "warn",
-       "error",
-       "time",
-       "timeEnd",
-     ],
-   },
],

- "no-new": "off"
+ "no-new": "error",

- "no-plusplus": "off"
+ "no-plusplus": "error",

"object-shorthand": Array [
    "error",
-   "methods",
+   "always",
+   Object {
+     "avoidQuotes": true,
+     "ignoreConstructors": false,
+   },
],

• config: now exports only the recommended config, Prettier-compatible. There is no reason to have separate config since it no longer mandates Prettier usage.
• config: Removed eslint-plugin-prettier, and its prettier/prettier rule from the config. Projects should have Prettier running without ESLint anyway so it also processes other file types. Running it within Prettier offers marginal improvements only, and has a performance drawback, as well as unnecessarily tying together formatting choices governed by Prettier and the ESLint config.

3.0.3 (2018-09-17)

Bug Fixes

• config: remove option that does not serialise as JSON (e85f0c5)

3.0.2 (2018-09-17)

Bug Fixes

• config: make import/no-cycle config serialisable to JSON (5e06bbb)

3.0.1 (2018-09-17)

Bug Fixes

• config: fix exposed configs being invalid because of new attributes (a6f46f7)
• release: fix package.main pointing at the wrong file (f896eac)

3.0.0 (2018-09-16)

First release