README.md

eslint-plugin-prettier

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

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 prettier eslint-plugin-prettier

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

Then, in your .eslintrc:

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

Options

• The first option:

  • Objects are passed directly to Prettier as options. Example:

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

  • Or the string "fb" may be used to set "Facebook style" defaults:

    "prettier/prettier": ["error", "fb"]

    Equivalent to:

    "prettier/prettier": ["error", {
      "singleQuote": true,
      "trailingComma": "all",
      "bracketSpacing": false,
      "jsxBracketSameLine": true,
      "parser": "flow"
    }]

• The second option:

  • A string with a pragma that triggers this rule. By default, this rule applies to all files. However, if you set a pragma (this option), only files with that pragma in the heading docblock will be checked. All pragmas must start with @. Example:

    "prettier/prettier": ["error", null, "@prettier"]

    Only files with @prettier in the heading docblock will be checked:

    /** @prettier */
    
    console.log(1 + 2 + 3);

    Or:

    /**
     * @prettier
     */
    
    console.log(4 + 5 + 6);

    This option is useful if you're migrating a large codebase and already use pragmas like @flow.

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

---

This plugin works best if you disable all other ESLint rules relating to code formatting, and only enable rules that detect patterns in the AST. (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. If your desired formatting does not match the prettier output, you should use a different tool such as prettier-eslint instead.

Contributing

See CONTRIBUTING.md