eslint-plugin-prettier 4.1.0 → 4.2.0

package/README.md

@@ -95,6 +95,10 @@ Exactly what does `plugin:prettier/recommended` do? Well, this is what it expand
 - `"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`](https://github.com/ota-meshi/eslint-plugin-svelte) instead of [`eslint-plugin-svelte3`](https://github.com/sveltejs/eslint-plugin-svelte3) because `eslint-plugin-svelte` has a correct [`eslint-svelte-parser`](https://github.com/ota-meshi/svelte-eslint-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](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).
@@ -114,7 +118,9 @@ If you’re fixing large of amounts of previously unformatted code, consider tem
   - An object representing [options](https://prettier.io/docs/en/options.html) that will be passed into prettier. Example:
 
     ```json
-    "prettier/prettier": ["error", {"singleQuote": true, "parser": "flow"}]
+    {
+      "prettier/prettier": ["error", { "singleQuote": true, "parser": "flow" }]
+    }
     ```
 
     NB: This option will merge and override any config set with `.prettierrc` files
@@ -126,25 +132,45 @@ If you’re fixing large of amounts of previously unformatted code, consider tem
     - `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.
 
       ```json
-      "prettier/prettier": ["error", {}, {
-        "usePrettierrc": false
-      }]
+      {
+        "prettier/prettier": [
+          "error",
+          {},
+          {
+            "usePrettierrc": false
+          }
+        ]
+      }
       ```
 
     - `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", {}, {
-        "fileInfoOptions": {
-          "withNodeModules": true
-        }
-      }]
+      {
+        "prettier/prettier": [
+          "error",
+          {},
+          {
+            "fileInfoOptions": {
+              "withNodeModules": true
+            }
+          }
+        ]
+      }
       ```
 
-- The rule is autofixable -- if you run `eslint` with the `--fix` flag, your code will be formatted according to `prettier` style.
+- 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](https://github.com/prettier/eslint-plugin-prettier/blob/master/CONTRIBUTING.md)
+
+## Changelog
+
+Detailed changes for each release are documented in [CHANGELOG.md](./CHANGELOG.md).
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT)

package/eslint-plugin-prettier.js

@@ -1,5 +1,5 @@
 /**
- * @fileoverview Runs `prettier` as an ESLint rule.
+ * @file Runs `prettier` as an ESLint rule.
  * @author Andres Suarez
  */
 
@@ -36,6 +36,7 @@ let prettier;
 
 /**
  * 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}
@@ -43,8 +44,8 @@ let prettier;
 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)
+  const [start, end] = range.map(index =>
+    context.getSourceCode().getLocFromIndex(index),
   );
 
   context.report({
@@ -54,7 +55,7 @@ function reportDifference(context, difference) {
       insertText: showInvisibles(insertText),
     },
     loc: { start, end },
-    fix: (fixer) => fixer.replaceTextRange(range, insertText),
+    fix: fixer => fixer.replaceTextRange(range, insertText),
   });
 }
 
@@ -124,6 +125,7 @@ module.exports = {
         const source = sourceCode.text;
 
         return {
+          // eslint-disable-next-line sonarjs/cognitive-complexity
           Program() {
             if (!prettier) {
               // Prettier is expensive to load, so only load it if needed.
@@ -140,11 +142,11 @@ module.exports = {
 
             const { ignored, inferredParser } = prettier.getFileInfo.sync(
               onDiskFilepath,
-              Object.assign(
-                {},
-                { resolveConfig: true, ignorePath: '.prettierignore' },
-                eslintFileInfoOptions
-              )
+              {
+                resolveConfig: true,
+                ignorePath: '.prettierignore',
+                ...eslintFileInfoOptions,
+              },
             );
 
             // Skip if file is ignored using a .prettierignore file
@@ -185,20 +187,33 @@ module.exports = {
               // by default.
               // Related ESLint plugins are:
               // 1. `eslint-plugin-graphql` (replacement: `@graphql-eslint/eslint-plugin`)
-              // 2. `eslint-plugin-markdown@1` (replacement: `eslint-plugin-markdown@2+`)
-              // 3. `eslint-plugin-html`
+              // 2. `eslint-plugin-html`
+              // 3. `eslint-plugin-markdown@1` (replacement: `eslint-plugin-markdown@2+`)
+              // 4. `eslint-plugin-svelte3` (replacement: `eslint-plugin-svelte@2+`)
               const parserBlocklist = [null, 'markdown', 'html'];
 
-              let inferParserToBabel =
-                parserBlocklist.indexOf(inferredParser) !== -1;
+              let inferParserToBabel = parserBlocklist.includes(inferredParser);
 
-              if (
+              switch (inferredParser) {
                 // it could be processed by `@graphql-eslint/eslint-plugin` or `eslint-plugin-graphql`
-                inferredParser === 'graphql' &&
-                // for `eslint-plugin-graphql`, see https://github.com/apollographql/eslint-plugin-graphql/blob/master/src/index.js#L416
-                source.startsWith('ESLintPluginGraphQLFile`')
-              ) {
-                inferParserToBabel = true;
+                case 'graphql': {
+                  if (
+                    // for `eslint-plugin-graphql`, see https://github.com/apollographql/eslint-plugin-graphql/blob/master/src/index.js#L416
+                    source.startsWith('ESLintPluginGraphQLFile`')
+                  ) {
+                    inferParserToBabel = true;
+                  }
+                  break;
+                }
+                // it could be processed by `@ota-meshi/eslint-plugin-svelte`, `eslint-plugin-svelte` or `eslint-plugin-svelte3`
+                case 'svelte': {
+                  // The `source` would be modified by `eslint-plugin-svelte3`
+                  if (!context.parserPath.includes('svelte-eslint-parser')) {
+                    // We do not support `eslint-plugin-svelte3`,
+                    // the users should run `prettier` on `.svelte` files manually
+                    return;
+                  }
+                }
               }
 
               if (inferParserToBabel) {
@@ -222,19 +237,19 @@ module.exports = {
                 'html',
                 'mdx',
                 'angular',
+                'svelte',
               ];
-              if (parserBlocklist.indexOf(inferredParser) !== -1) {
+              if (parserBlocklist.includes(inferredParser)) {
                 return;
               }
             }
 
-            const prettierOptions = Object.assign(
-              {},
-              initialOptions,
-              prettierRcOptions,
-              eslintPrettierOptions,
-              { filepath }
-            );
+            const prettierOptions = {
+              ...initialOptions,
+              ...prettierRcOptions,
+              ...eslintPrettierOptions,
+              filepath,
+            };
 
             // prettier.format() may throw a SyntaxError if it cannot parse the
             // source code it is given. Usually for JS files this isn't a

package/package.json

@@ -1,67 +1,71 @@
 {
   "name": "eslint-plugin-prettier",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "Runs prettier as an eslint rule",
+  "repository": "git+https://github.com/prettier/eslint-plugin-prettier.git",
+  "homepage": "https://github.com/prettier/eslint-plugin-prettier#readme",
+  "author": "Teddy Katz",
+  "contributors": [
+    "JounQin (https://github.com/JounQin) <admin@1stg.me>"
+  ],
+  "license": "MIT",
+  "engines": {
+    "node": ">=12.0.0"
+  },
+  "main": "eslint-plugin-prettier.js",
+  "files": [
+    "eslint-plugin-prettier.js"
+  ],
   "keywords": [
     "eslint",
     "eslintplugin",
     "eslint-plugin",
     "prettier"
   ],
-  "author": "Teddy Katz",
-  "files": [
-    "eslint-plugin-prettier.js"
-  ],
-  "main": "eslint-plugin-prettier.js",
   "scripts": {
-    "lint": "eslint .",
-    "test": "npm run lint && mocha",
-    "format": "yarn run prettier '**/*.{js,json,md,yml}' --write && yarn run lint --fix",
-    "generate-release": "node-release-script"
+    "format": "yarn prettier '**/*.{js,json,md,yml}' --write && yarn lint --fix",
+    "lint": "eslint . --cache -f friendly --max-warnings 10",
+    "prepare": "patch-package && simple-git-hooks && yarn-deduplicate --strategy fewer || exit 0",
+    "prerelease": "yarn format && yarn test",
+    "release": "changeset publish",
+    "test": "yarn lint && mocha"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/prettier/eslint-plugin-prettier.git"
+  "peerDependencies": {
+    "eslint": ">=7.28.0",
+    "prettier": ">=2.0.0"
   },
-  "bugs": {
-    "url": "https://github.com/prettier/eslint-plugin-prettier/issues"
+  "peerDependenciesMeta": {
+    "eslint-config-prettier": {
+      "optional": true
+    }
   },
-  "homepage": "https://github.com/prettier/eslint-plugin-prettier#readme",
   "dependencies": {
     "prettier-linter-helpers": "^1.0.0"
   },
-  "peerDependencies": {
-    "eslint": ">=7.28.0",
-    "prettier": ">=2.0.0"
-  },
   "devDependencies": {
+    "@1stg/common-config": "~3.0.0",
+    "@1stg/eslint-config": "~3.0.0",
+    "@changesets/changelog-github": "^0.4.5",
+    "@changesets/cli": "^2.23.0",
     "@graphql-eslint/eslint-plugin": "^2.5.0",
-    "@not-an-aardvark/node-release-script": "^0.1.0",
+    "@ota-meshi/eslint-plugin-svelte": "^0.34.1",
     "@typescript-eslint/parser": "^5.29.0",
-    "eslint": "^8.18.0",
-    "eslint-config-not-an-aardvark": "^2.1.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-mdx": "^1.17.0",
     "eslint-plugin-eslint-plugin": "^4.3.0",
     "eslint-plugin-mdx": "^1.17.0",
-    "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "link:.",
     "eslint-plugin-self": "^1.2.1",
+    "eslint-plugin-utils": "^0.1.0",
     "graphql": "^16.5.0",
     "mocha": "^9.2.2",
+    "patch-package": "^6.4.7",
     "prettier": "^2.7.1",
+    "svelte": "^3.48.0",
     "vue-eslint-parser": "^8.3.0"
   },
-  "peerDependenciesMeta": {
-    "eslint-config-prettier": {
-      "optional": true
-    }
-  },
   "resolutions": {
-    "@babel/traverse": "^7.18.5"
-  },
-  "engines": {
-    "node": ">=12.0.0"
+    "@babel/traverse": "^7.18.5",
+    "eslint-plugin-prettier": "link:."
   },
-  "license": "MIT"
+  "packageManager": "yarn@1.22.19"
 }