eslint-plugin-prettier

What is eslint-plugin-prettier?

The eslint-plugin-prettier npm package integrates Prettier, an opinionated code formatter, with ESLint, a tool for identifying and reporting on patterns in JavaScript. It allows you to use Prettier as an ESLint rule and reports differences as individual ESLint issues.

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

Code Formatting

Automatically format code to match the style specified in your Prettier configuration when you run ESLint with the --fix option.

"scripts": { "lint": "eslint --fix 'src/**/*.js'" }

Integration with ESLint Rules

Use Prettier to enforce a consistent code style while still using ESLint to catch possible errors.

{ "extends": ["plugin:prettier/recommended"] }

Customizable Formatting Rules

Override default Prettier options to tailor the formatting to your project's needs.

{ "rules": { "prettier/prettier": ["error", { "singleQuote": true, "parser": "flow" }] } }

Other packages similar to eslint-plugin-prettier

eslint-config-prettier

Turns off all ESLint rules that are unnecessary or might conflict with Prettier. It's used to avoid conflicts between ESLint and Prettier formatting rules.

prettier-eslint

Formats your JavaScript using Prettier followed by ESLint --fix. It's similar to eslint-plugin-prettier but applies Prettier formatting first and then runs ESLint's auto-fixing feature.

stylelint-prettier

Runs Prettier as a Stylelint rule and reports differences as individual Stylelint issues. It's similar to eslint-plugin-prettier but for stylesheets and integrates with Stylelint instead of ESLint.

tslint-config-prettier

Disables TSLint formatting rules that might conflict with Prettier. It's similar to eslint-config-prettier but for TypeScript projects using TSLint instead of ESLint.

README

eslint-plugin-prettier

Runs Prettier as an ESLint rule and reports differences as individual ESLint issues.

If your desired formatting does not match Prettier’s output, you should use a different tool such as prettier-eslint instead.

Please read Integrating with linters before installing.

Sample

error: Insert `,` (prettier/prettier) at pkg/commons-atom/ActiveEditorRegistry.js:22:25:
  20 | import {
  21 |   observeActiveEditorsDebounced,
> 22 |   editorChangesDebounced
     |                         ^
  23 | } from './debounced';;
  24 |
  25 | import {observableFromSubscribeFunction} from '../commons-node/event';


error: Delete `;` (prettier/prettier) at pkg/commons-atom/ActiveEditorRegistry.js:23:21:
  21 |   observeActiveEditorsDebounced,
  22 |   editorChangesDebounced
> 23 | } from './debounced';;
     |                     ^
  24 |
  25 | import {observableFromSubscribeFunction} from '../commons-node/event';
  26 | import {cacheWhileSubscribed} from '../commons-node/observable';


2 errors found.

./node_modules/.bin/eslint --format codeframe pkg/commons-atom/ActiveEditorRegistry.js (code from nuclide).

Installation

npm install --save-dev eslint-plugin-prettier
npm install --save-dev --save-exact prettier

eslint-plugin-prettier does not install Prettier or ESLint for you. You must install these yourself.

Then, in your .eslintrc.json:

{
  "plugins": ["prettier"],
  "rules": {
    "prettier/prettier": "error"
  }
}

Recommended Configuration

This plugin works best if you disable all other ESLint rules relating to code formatting, and only enable rules that detect potential bugs. (If another active ESLint rule disagrees with prettier about how code should be formatted, it will be impossible to avoid lint errors.) You can use eslint-config-prettier to disable all formatting-related ESLint rules.

This plugin ships with a plugin:prettier/recommended config that sets up both the plugin and eslint-config-prettier in one go.

1. In addition to the above installation instructions, install eslint-config-prettier:

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

2. Then you need to add plugin:prettier/recommended as the last extension in your .eslintrc.json:

   {
     "extends": ["plugin:prettier/recommended"]
   }
   

   You can then set Prettier's own options inside a .prettierrc file.

Exactly what does plugin:prettier/recommended do? Well, this is what it expands to:

{
  "extends": ["prettier"],
  "plugins": ["prettier"],
  "rules": {
    "prettier/prettier": "error",
    "arrow-body-style": "off",
    "prefer-arrow-callback": "off"
  }
}

• "extends": ["prettier"] enables the config from eslint-config-prettier, which turns off some ESLint rules that conflict with Prettier.
• "plugins": ["prettier"] registers this plugin.
• "prettier/prettier": "error" turns on the rule provided by this plugin, which runs Prettier from within ESLint.
• "arrow-body-style": "off" and "prefer-arrow-callback": "off" turns off two ESLint core rules that unfortunately are problematic with this plugin – see the next section.

Svelte support

We recommend to use eslint-plugin-svelte instead of eslint-plugin-svelte3 because eslint-plugin-svelte has a correct eslint-svelte-parser instead of hacking, when use with eslint-plugin-svelte3, eslint-plugin-prettier will just ignore the text passed by eslint-plugin-svelte3, because the text they has been modified.

arrow-body-style and prefer-arrow-callback issue

If you use arrow-body-style or prefer-arrow-callback together with the prettier/prettier rule from this plugin, you can in some cases end up with invalid code due to a bug in ESLint’s autofix – see issue #65.

For this reason, it’s recommended to turn off these rules. The plugin:prettier/recommended config does that for you.

You can still use these rules together with this plugin if you want, because the bug does not occur all the time. But if you do, you need to keep in mind that you might end up with invalid code, where you manually have to insert a missing closing parenthesis to get going again.

If you’re fixing large of amounts of previously unformatted code, consider temporarily disabling the prettier/prettier rule and running eslint --fix and prettier --write separately.

Options

Note: While it is possible to pass options to Prettier via your ESLint configuration file, it is not recommended because editor extensions such as prettier-atom and prettier-vscode will read .prettierrc, but won't read settings from ESLint, which can lead to an inconsistent experience.

• The first option:

  • An object representing options that will be passed into prettier. Example:

    {
      "prettier/prettier": ["error", { "singleQuote": true, "parser": "flow" }]
    }
    

    NB: This option will merge and override any config set with .prettierrc files

• The second option:

  • An object with the following options

    • usePrettierrc: Enables loading of the Prettier configuration file, (default: true). May be useful if you are using multiple tools that conflict with each other, or do not wish to mix your ESLint settings with your Prettier configuration.

      {
        "prettier/prettier": [
          "error",
          {},
          {
            "usePrettierrc": false
          }
        ]
      }
      

    • fileInfoOptions: Options that are passed to prettier.getFileInfo to decide whether a file needs to be formatted. Can be used for example to opt-out from ignoring files located in node_modules directories.

      {
        "prettier/prettier": [
          "error",
          {},
          {
            "fileInfoOptions": {
              "withNodeModules": true
            }
          }
        ]
      }
      

• The rule is auto fixable -- if you run eslint with the --fix flag, your code will be formatted according to prettier style.

---

Contributing

See CONTRIBUTING.md

Changelog

Detailed changes for each release are documented in CHANGELOG.md.

License

MIT