eslint-plugin-prettier
Advanced tools
Package description
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.
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" }] } }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.
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.
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.
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.
Changelog
Readme
Runs Prettier as an ESLint rule and reports differences as individual ESLint issues.
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).
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"
}
}
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.
See CONTRIBUTING.md
FAQs
Runs prettier as an eslint rule
We found that eslint-plugin-prettier demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.