eslint-plugin-prettier 3.1.4 → 3.4.0

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # Changelog
 
+## v3.4.0 (2021-04-15)
+
+* feat: support processor virtual filename ([#401](git@github.com:prettier/eslint-plugin-prettier/issues/401)) ([ee0ccc6](git@github.com:prettier/eslint-plugin-prettier/commit/ee0ccc6ac06d13cd546e78b444e53164f59eb27f))
+* Simplify report logic ([#380](git@github.com:prettier/eslint-plugin-prettier/issues/380)) ([d993f24](git@github.com:prettier/eslint-plugin-prettier/commit/d993f247b5661683af031ab3b93955a0dfe448fa))
+* Update: README.md ([#375](git@github.com:prettier/eslint-plugin-prettier/issues/375)) ([3ea4242](git@github.com:prettier/eslint-plugin-prettier/commit/3ea4242a8d4acdb76eb7e7dca9e44d3e87db70e3))
+
+## v3.3.1 (2021-01-04)
+
+* fix: add eslint-config-prettier as an optional peer dependency ([#374](git@github.com:prettier/eslint-plugin-prettier/issues/374)) ([d59df27](git@github.com:prettier/eslint-plugin-prettier/commit/d59df27890aaffec9e528ceb3155831a0261848d))
+* build(deps-dev): bump eslint from 7.16.0 to 7.17.0 ([b87985d](git@github.com:prettier/eslint-plugin-prettier/commit/b87985d8b1986743374b56691bcc1633df8f4eae))
+* build(deps-dev): bump eslint from 7.15.0 to 7.16.0 ([11e427e](git@github.com:prettier/eslint-plugin-prettier/commit/11e427e5d6cedeb26e3e03c8143be3496a24955a))
+
+## v3.3.0 (2020-12-13)
+
+* Minor: Perf improvement: Do not clear the config cache on each run ([#368](git@github.com:prettier/eslint-plugin-prettier/issues/368)) ([1b90ea7](git@github.com:prettier/eslint-plugin-prettier/commit/1b90ea752636959babb27ebca5d67093c346dab9))
+* Add peerDependenciesMeta block ([#367](git@github.com:prettier/eslint-plugin-prettier/issues/367)) ([86608d5](git@github.com:prettier/eslint-plugin-prettier/commit/86608d5084692ab0d1f2f49a3df4909d04c39ae7))
+* build(deps-dev): bump eslint from 7.14.0 to 7.15.0 ([885f484](git@github.com:prettier/eslint-plugin-prettier/commit/885f48405e0fc9f312acdd3e3487c824bd59c102))
+* build(deps-dev): bump eslint from 7.3.1 to 7.14.0 ([cebc80b](git@github.com:prettier/eslint-plugin-prettier/commit/cebc80b39d3d09f957a73536e54f6d8dd4567080))
+
+## v3.2.0 (2020-12-03)
+
+* Skip CI for eslint 6 + node 8 ([#364](git@github.com:prettier/eslint-plugin-prettier/issues/364)) ([f8f08e4](git@github.com:prettier/eslint-plugin-prettier/commit/f8f08e483522d74bc4dd93d9813914aa7ba9314b))
+* Turn off problematic rules in recommended config (prepare for next eslint-config-prettier version) ([#360](git@github.com:prettier/eslint-plugin-prettier/issues/360)) ([a1e5591](git@github.com:prettier/eslint-plugin-prettier/commit/a1e559112073eedfb0dd2041b9c2f6ef775844ec))
+* Create dependabot.yml ([f58b6c7](git@github.com:prettier/eslint-plugin-prettier/commit/f58b6c7c356a37b437593cd6ff8d1dca1c437b13))
+* docs(README): fix prettier getFileInfo link ([#335](git@github.com:prettier/eslint-plugin-prettier/issues/335)) ([5a690f1](git@github.com:prettier/eslint-plugin-prettier/commit/5a690f14d793ba5a08c55287fa3d6338dcda21ba))
+* build(deps-dev): bump eslint-plugin-eslint-plugin from 2.2.2 to 2.3.0 ([8614c45](git@github.com:prettier/eslint-plugin-prettier/commit/8614c458ed284bc126034d432b49b07d7d67ef06))
+* build(deps-dev): bump eslint from 7.3.0 to 7.3.1 ([12d9ed8](git@github.com:prettier/eslint-plugin-prettier/commit/12d9ed877aacfad2c27f01161cc2eb28a445725f))
+* build(deps-dev): bump eslint from 7.2.0 to 7.3.0 ([5a6f42e](git@github.com:prettier/eslint-plugin-prettier/commit/5a6f42e4eda871a294da1eb55f214c475450faa6))
+* chore: update CI badge in readme ([5012b66](git@github.com:prettier/eslint-plugin-prettier/commit/5012b665f981edbc21feaaccb3cd297f49ca40d3))
+* Use Github Actions for CI ([#305](git@github.com:prettier/eslint-plugin-prettier/issues/305)) ([41eb64f](git@github.com:prettier/eslint-plugin-prettier/commit/41eb64fda33663ed1c43a85218f390c6cd4b6191))
+
 ## v3.1.4 (2020-06-14)
 
 * Avoid clearing Prettier cache when not using prettierrc ([#303](git@github.com:prettier/eslint-plugin-prettier/issues/303)) ([3c8e2d9](git@github.com:prettier/eslint-plugin-prettier/commit/3c8e2d9871d86a82b10fe3d54f32bb5a54f2913b))

package/README.md

@@ -1,7 +1,11 @@
-# eslint-plugin-prettier [![Build Status](https://travis-ci.org/prettier/eslint-plugin-prettier.svg?branch=master)](https://travis-ci.org/prettier/eslint-plugin-prettier)
+# eslint-plugin-prettier [![Build Status](https://github.com/prettier/eslint-plugin-prettier/workflows/CI/badge.svg?branch=master)](https://github.com/prettier/eslint-plugin-prettier/actions?query=workflow%3ACI+branch%3Amaster)
 
 Runs [Prettier](https://github.com/prettier/prettier) as an [ESLint](http://eslint.org) 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](https://github.com/prettier/prettier-eslint) instead.
+
+Please read [Integrating with linters](https://prettier.io/docs/en/integrating-with-linters.html) before installing.
+
 ## Sample
 
 ```js
@@ -52,11 +56,9 @@ Then, in your `.eslintrc.json`:
 
 ## Recommended Configuration
 
-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](https://github.com/prettier/eslint-config-prettier) to disable all formatting-related ESLint rules.
+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](https://github.com/prettier/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](https://github.com/prettier/prettier-eslint) instead.
-
-To integrate this plugin with `eslint-config-prettier`, you can use the `"recommended"` configuration:
+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`:
 
@@ -64,7 +66,7 @@ To integrate this plugin with `eslint-config-prettier`, you can use the `"recomm
    npm install --save-dev eslint-config-prettier
    ```
 
-2. Then you need to add `plugin:prettier/recommended` as the last extension in your `.eslintrc.json`:
+2. Then you need to add `plugin:prettier/recommended` as the _last_ extension in your `.eslintrc.json`:
 
    ```json
    {
@@ -72,28 +74,36 @@ To integrate this plugin with `eslint-config-prettier`, you can use the `"recomm
    }
    ```
 
-This does three things:
-
-- Enables `eslint-plugin-prettier`.
-- Sets the `prettier/prettier` rule to `"error"`.
-- Extends the `eslint-config-prettier` configuration.
+   You can then set Prettier's own options inside a `.prettierrc` file.
 
-You can then set Prettier's own options inside a `.prettierrc` file.
-
-3. In order to support special ESLint plugins (e.g. [eslint-plugin-react](https://github.com/yannickcr/eslint-plugin-react)), add extra exclusions for the plugins you use like so:
+Exactly what does `plugin:prettier/recommended` do? Well, this is what it expands to:
 
 ```json
 {
-  "extends": [
-    "plugin:prettier/recommended",
-    "prettier/flowtype",
-    "prettier/react",
-    "prettier/standard"
-  ]
+  "extends": ["prettier"],
+  "plugins": ["prettier"],
+  "rules": {
+    "prettier/prettier": "error",
+    "arrow-body-style": "off",
+    "prefer-arrow-callback": "off"
+  }
 }
 ```
 
-For the list of every available exclusion rule set, please see the [readme of eslint-config-prettier](https://github.com/prettier/eslint-config-prettier/blob/master/README.md).
+- `"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.
+
+## `arrow-body-style` and `prefer-arrow-callback` issue
+
+If you use [arrow-body-style](https://eslint.org/docs/rules/arrow-body-style) or [prefer-arrow-callback](https://eslint.org/docs/rules/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](https://github.com/prettier/eslint-plugin-prettier/issues/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
 
@@ -121,7 +131,7 @@ For the list of every available exclusion rule set, please see the [readme of es
       }]
       ```
 
-    - `fileInfoOptions`: Options that are passed to [prettier.getFileInfo](https://prettier.io/docs/en/api.html#prettiergetfileinfofilepath-options) 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.
+    - `fileInfoOptions`: Options that are passed to [prettier.getFileInfo](https://prettier.io/docs/en/api.html#prettiergetfileinfofilepath--options) 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.
 
       ```json
       "prettier/prettier": ["error", {}, {

package/eslint-plugin-prettier.js

@@ -9,6 +9,9 @@
 //  Requirements
 // ------------------------------------------------------------------------------
 
+const fs = require('fs');
+const path = require('path');
+
 const {
   showInvisibles,
   generateDifferences
@@ -25,6 +28,9 @@ const { INSERT, DELETE, REPLACE } = generateDifferences;
 // ------------------------------------------------------------------------------
 
 // Lazily-loaded Prettier.
+/**
+ * @type {import('prettier')}
+ */
 let prettier;
 
 // ------------------------------------------------------------------------------
@@ -32,72 +38,49 @@ let prettier;
 // ------------------------------------------------------------------------------
 
 /**
- * Reports an "Insert ..." issue where text must be inserted.
- * @param {RuleContext} context - The ESLint rule context.
- * @param {number} offset - The source offset where to insert text.
- * @param {string} text - The text to be inserted.
+ * Reports a difference.
+ * @param {import('eslint').Rule.RuleContext} context - The ESLint rule context.
+ * @param {import('prettier-linter-helpers').Difference} difference - The difference object.
  * @returns {void}
  */
-function reportInsert(context, offset, text) {
-  const pos = context.getSourceCode().getLocFromIndex(offset);
-  const range = [offset, offset];
-  context.report({
-    message: 'Insert `{{ code }}`',
-    data: { code: showInvisibles(text) },
-    loc: { start: pos, end: pos },
-    fix(fixer) {
-      return fixer.insertTextAfterRange(range, text);
-    }
-  });
-}
+function reportDifference(context, difference) {
+  const { operation, offset, deleteText = '', insertText = '' } = difference;
+  const range = [offset, offset + deleteText.length];
+  const [start, end] = range.map(index =>
+    context.getSourceCode().getLocFromIndex(index)
+  );
 
-/**
- * Reports a "Delete ..." issue where text must be deleted.
- * @param {RuleContext} context - The ESLint rule context.
- * @param {number} offset - The source offset where to delete text.
- * @param {string} text - The text to be deleted.
- * @returns {void}
- */
-function reportDelete(context, offset, text) {
-  const start = context.getSourceCode().getLocFromIndex(offset);
-  const end = context.getSourceCode().getLocFromIndex(offset + text.length);
-  const range = [offset, offset + text.length];
   context.report({
-    message: 'Delete `{{ code }}`',
-    data: { code: showInvisibles(text) },
+    messageId: operation,
+    data: {
+      deleteText: showInvisibles(deleteText),
+      insertText: showInvisibles(insertText)
+    },
     loc: { start, end },
-    fix(fixer) {
-      return fixer.removeRange(range);
-    }
+    fix: fixer => fixer.replaceTextRange(range, insertText)
   });
 }
 
 /**
- * Reports a "Replace ... with ..." issue where text must be replaced.
- * @param {RuleContext} context - The ESLint rule context.
- * @param {number} offset - The source offset where to replace deleted text
- with inserted text.
- * @param {string} deleteText - The text to be deleted.
- * @param {string} insertText - The text to be inserted.
- * @returns {void}
+ * Given a filepath, get the nearest path that is a regular file.
+ * The filepath provided by eslint may be a virtual filepath rather than a file
+ * on disk. This attempts to transform a virtual path into an on-disk path
+ * @param {string} filepath
+ * @returns {string}
  */
-function reportReplace(context, offset, deleteText, insertText) {
-  const start = context.getSourceCode().getLocFromIndex(offset);
-  const end = context
-    .getSourceCode()
-    .getLocFromIndex(offset + deleteText.length);
-  const range = [offset, offset + deleteText.length];
-  context.report({
-    message: 'Replace `{{ deleteCode }}` with `{{ insertCode }}`',
-    data: {
-      deleteCode: showInvisibles(deleteText),
-      insertCode: showInvisibles(insertText)
-    },
-    loc: { start, end },
-    fix(fixer) {
-      return fixer.replaceTextRange(range, insertText);
+function getOnDiskFilepath(filepath) {
+  try {
+    if (fs.statSync(filepath).isFile()) {
+      return filepath;
     }
-  });
+  } catch (err) {
+    // https://github.com/eslint/eslint/issues/11989
+    if (err.code === 'ENOTDIR') {
+      return getOnDiskFilepath(path.dirname(filepath));
+    }
+  }
+
+  return filepath;
 }
 
 // ------------------------------------------------------------------------------
@@ -110,7 +93,9 @@ module.exports = {
       extends: ['prettier'],
       plugins: ['prettier'],
       rules: {
-        'prettier/prettier': 'error'
+        'prettier/prettier': 'error',
+        'arrow-body-style': 'off',
+        'prefer-arrow-callback': 'off'
       }
     }
   },
@@ -141,7 +126,12 @@ module.exports = {
             },
             additionalProperties: true
           }
-        ]
+        ],
+        messages: {
+          [INSERT]: 'Insert `{{ insertText }}`',
+          [DELETE]: 'Delete `{{ deleteText }}`',
+          [REPLACE]: 'Replace `{{ deleteText }}` with `{{ insertText }}`'
+        }
       },
       create(context) {
         const usePrettierrc =
@@ -150,17 +140,16 @@ module.exports = {
           (context.options[1] && context.options[1].fileInfoOptions) || {};
         const sourceCode = context.getSourceCode();
         const filepath = context.getFilename();
+        // Processors that extract content from a file, such as the markdown
+        // plugin extracting fenced code blocks may choose to specify virtual
+        // file paths. If this is the case then we need to resolve prettier
+        // config and file info using the on-disk path instead of the virtual
+        // path.
+        // See https://github.com/eslint/eslint/issues/11989 for ideas around
+        // being able to get this value directly from eslint in the future.
+        const onDiskFilepath = getOnDiskFilepath(filepath);
         const source = sourceCode.text;
 
-        // This allows long-running ESLint processes (e.g. vscode-eslint) to
-        // pick up changes to .prettierrc without restarting the editor. This
-        // will invalidate the prettier plugin cache on every file as well which
-        // will make ESLint very slow, so it would probably be a good idea to
-        // find a better way to do this.
-        if (usePrettierrc && prettier && prettier.clearConfigCache) {
-          prettier.clearConfigCache();
-        }
-
         return {
           Program() {
             if (!prettier) {
@@ -171,13 +160,13 @@ module.exports = {
             const eslintPrettierOptions = context.options[0] || {};
 
             const prettierRcOptions = usePrettierrc
-              ? prettier.resolveConfig.sync(filepath, {
+              ? prettier.resolveConfig.sync(onDiskFilepath, {
                   editorconfig: true
                 })
               : null;
 
             const prettierFileInfo = prettier.getFileInfo.sync(
-              filepath,
+              onDiskFilepath,
               Object.assign(
                 {},
                 { resolveConfig: true, ignorePath: '.prettierignore' },
@@ -192,7 +181,7 @@ module.exports = {
 
             const initialOptions = {};
 
-            // ESLint suppports processors that let you extract and lint JS
+            // ESLint supports processors that let you extract and lint JS
             // fragments within a non-JS language. In the cases where prettier
             // supports the same language as a processor, we want to process
             // the provided source code as javascript (as ESLint provides the
@@ -200,9 +189,14 @@ module.exports = {
             // based off the filename. Otherwise, for instance, on a .md file we
             // end up trying to run prettier over a fragment of JS using the
             // markdown parser, which throws an error.
-            // If we can't infer the parser from from the filename, either
-            // because no filename was provided or because there is no parser
-            // found for the filename, use javascript.
+            // Processors may set virtual filenames for these extracted blocks.
+            // If they do so then we want to trust the file extension they
+            // provide, and no override is needed.
+            // If the processor does not set any virtual filename (signified by
+            // `filepath` and `onDiskFilepath` being equal) AND we can't
+            // infer the parser from the filename, either because no filename
+            // was provided or because there is no parser found for the
+            // filename, use javascript.
             // This is added to the options first, so that
             // prettierRcOptions and eslintPrettierOptions can still override
             // the parser.
@@ -214,6 +208,7 @@ module.exports = {
             //   from the file type.
             const parserBlocklist = [null, 'graphql', 'markdown', 'html'];
             if (
+              filepath === onDiskFilepath &&
               parserBlocklist.indexOf(prettierFileInfo.inferredParser) !== -1
             ) {
               // Prettier v1.16.0 renamed the `babylon` parser to `babel`
@@ -234,7 +229,7 @@ module.exports = {
             );
 
             // prettier.format() may throw a SyntaxError if it cannot parse the
-            // source code it is given. Ususally for JS files this isn't a
+            // source code it is given. Usually for JS files this isn't a
             // problem as ESLint will report invalid syntax before trying to
             // pass it to the prettier plugin. However this might be a problem
             // for non-JS languages that are handled by a plugin. Notably Vue
@@ -252,7 +247,7 @@ module.exports = {
               let message = 'Parsing error: ' + err.message;
 
               // Prettier's message contains a codeframe style preview of the
-              // invalid code and the line/column at which the error occured.
+              // invalid code and the line/column at which the error occurred.
               // ESLint shows those pieces of information elsewhere already so
               // remove them from the message
               if (err.codeFrame) {
@@ -270,32 +265,9 @@ module.exports = {
             if (source !== prettierSource) {
               const differences = generateDifferences(source, prettierSource);
 
-              differences.forEach(difference => {
-                switch (difference.operation) {
-                  case INSERT:
-                    reportInsert(
-                      context,
-                      difference.offset,
-                      difference.insertText
-                    );
-                    break;
-                  case DELETE:
-                    reportDelete(
-                      context,
-                      difference.offset,
-                      difference.deleteText
-                    );
-                    break;
-                  case REPLACE:
-                    reportReplace(
-                      context,
-                      difference.offset,
-                      difference.deleteText,
-                      difference.insertText
-                    );
-                    break;
-                }
-              });
+              for (const difference of differences) {
+                reportDifference(context, difference);
+              }
             }
           }
         };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-prettier",
-  "version": "3.1.4",
+  "version": "3.4.0",
   "description": "Runs prettier as an eslint rule",
   "keywords": [
     "eslint",
@@ -46,6 +46,11 @@
     "prettier": "^1.15.3",
     "vue-eslint-parser": "^6.0.0"
   },
+  "peerDependenciesMeta": {
+    "eslint-config-prettier": {
+      "optional": true
+    }
+  },
   "engines": {
     "node": ">=6.0.0"
   },