eslint-config-prettier

What is eslint-config-prettier?

The eslint-config-prettier npm package is used to disable all formatting-related ESLint rules that might conflict with Prettier. This allows developers to use both ESLint and Prettier without having to deal with conflicting formatting rules. It ensures that ESLint focuses on code-quality rules, and Prettier takes care of code formatting.

What are eslint-config-prettier's main functionalities?

Disabling conflicting rules

By extending eslint-config-prettier in your ESLint configuration file, you can turn off all rules that are unnecessary or might conflict with Prettier.

{ "extends": ["prettier"] }

Integration with other ESLint configs

eslint-config-prettier can be easily integrated with other ESLint configurations like Airbnb by placing it last in the extends array, which ensures that it will override any other formatting rules that might conflict with Prettier.

{ "extends": ["airbnb", "prettier"] }

Support for plugins

eslint-config-prettier provides support for disabling conflicting rules from various ESLint plugins, such as React or TypeScript, ensuring compatibility across different codebases.

{ "extends": ["prettier/react", "prettier/@typescript-eslint"] }

Other packages similar to eslint-config-prettier

eslint-config-standard

eslint-config-standard is an ESLint Shareable Config for JavaScript Standard Style. It enforces a consistent style across your codebase. Unlike eslint-config-prettier, it does not turn off formatting rules and is not specifically designed to be used with Prettier.

eslint-config-airbnb

eslint-config-airbnb is one of the most popular ESLint configurations which enforces Airbnb's JavaScript style guide. It includes a set of rules for code quality and formatting. While it can be used with Prettier, it does not disable formatting rules by default like eslint-config-prettier does.

eslint-config-google

eslint-config-google is based on Google's JavaScript style guide. It provides a set of ESLint rules that align with Google's code style recommendations. Similar to eslint-config-airbnb, it is not tailored for use with Prettier and does not disable conflicting formatting rules.

README

eslint-config-prettier

Turns all rules that are unnecessary or might conflict with prettier off.

This let’s you use you favorite shareable config without letting its stylistic choices get in the way when using prettier.

Intended to be used together with eslint-plugin-prettier.

Installation

First, install eslint-plugin-prettier. Follow the instructions over there.

Then, install eslint-config-prettier:

$ npm install --save-dev eslint-config-prettier

Finally, add eslint-config-prettier to the "extends" array in your .eslintrc.* file. Make sure to put it last, so it gets the chance to override other configs.

{
  "extends": [
    "prettier"
  ]
}

A few ESLint plugins are supported as well:

• eslint-plugin-flowtype
• eslint-plugin-react

Add extra exclusions for the plugins you use like so:

{
  "extends": [
    "prettier",
    "prettier/flowtype",
    "prettier/react"
  ]
}

CLI helper tool

eslint-config-prettier also ships with a little CLI tool to help you check if your configuration contains any rules that are unnecessary or conflict with prettier.

First, add a script for it to package.json:

{
  "scripts": {
    "eslint-check": "eslint --print-config .eslintrc.js | eslint-config-prettier-check"
  }
}

Then run npm run eslint-check.

(Swap out .eslintrc.js with the path to your config if needed.)

Example configuration

{
  "extends": [
    "google",
    "plugin:flowtype/recommended",
    "plugin:react/recommended",
    "prettier",
    "prettier/flowtype",
    "prettier/react"
  ],
  "plugins": [
    "flowtype",
    "react",
    "prettier"
  ],
  "parserOptions": {
    "ecmaVersion": 2016,
    "sourceType": "module",
    "ecmaFeatures": {
      "jsx": true
    }
  },
  "env": {
    "es6": true,
    "node": true
  },
  "rules": {
    "prettier/prettier": "error"
  }
}

Special rules

There a few rules that eslint-config-prettier disables that actually can be enabled in some cases.

max-len

Usually, prettier takes care of following a maximum line length automatically. However, there are cases where prettier can’t do anything, such as for long strings, regular expressions and comments. Those need to be split up by a human.

If you’d like to enforce an even stricter maximum line length policy than prettier can provide automatically, you can enable this rule. Just remember to keep max-len’s options and prettier’s printWidth option in sync.

Example configuration:

{
  "rules": {
    "max-len": ["error", {"code": 80, "ignoreUrls": true}]
  }
}

no-mixed-operators

This rule forbids mixing certain operators, such as && and ||.

For example, the rule could warn about this line:

var foo = a && b || c;

The rule suggests adding parentheses, like this:

var foo = (a && b) || c;

However, prettier prints the minimum amount of parentheses technically needed, turning it back to:

var foo = a && b || c;

If you want to use this rule with prettier, you need to split the expression into another variable:

var bar = a && b;
var foo = bar || c;

Example configuration:

{
  "rules": {
    "no-mixed-operators": "error"
  }
}

quotes

If you’d like to enforce the use of backticks rather than single or double quotes for strings, you can enable this rule. Otherwise, there’s no need to. Just remember to enable the "backtick" option!

Example configuration:

{
  "rules": {
    "quotes": ["error", "backtick"]
  }
}

Contributing

eslint-config-prettier has been tested with:

• ESLint 3.15.0
• prettier 0.16.0
• eslint-plugin-flowtype 2.30.0
• eslint-plugin-react 6.9.0

Have new rules been added since those versions? Have we missed any rules? Is there a plugin you would like to see exclusions for? Open an issue or a pull request!

If you’d like to add support for eslint-plugin-foobar, this is how you’d go about it:

First, create foobar.js:

"use strict";

module.exports = {
  rules: {
    "foobar/some-rule": "off"
  }
};

Then, create test-lint/foobar.js:

/* eslint-disable quotes */
"use strict";

// prettier does not want spaces before the parentheses, but
// eslint-config-foobar wants one.
console.log ();

test-lint/foobar.js must fail when used with eslint-plugin-foobar and eslint-plugin-prettier at the same time – until "prettier/foobar" is added to the "extends" property of an ESLint config.

Finally, you need to mention the plugin in several places:

• Add "foobar.js" to the "files" field in package.json.
• Make sure that at least one rule from eslint-plugin-foobar gets used in .eslintrc.base.js.
• Add it to the list of supported plugins, to the example config and to Contributing section in README.md.

When you’re done, run npm test to verify that you got it all right. It runs several other npm scripts:

• "test:lint" makes sure that the files in test-lint/ pass ESLint when the exclusions from eslint-config-prettier are used. It also lints the code of eslint-config-prettier itself.
• "test:lint-verify-fail" is run by a test in test/lint-verify-fail.js.
• "test:lint-rules" is run by a test in test/rules.js.
• "test:ava" runs unit tests that check a number of things:
  • That eslint-plugin-foobar is mentioned in all the places shown above.
  • That no unknown rules are turned off. This helps catching typos, for example.
  • That the CLI works.
• "test:cli-sanity" is a sanity check for the CLI.

License

MIT.