eslint-plugin-prettier - npm Package Compare versions

Comparing version 5.1.1 to 5.1.2

eslint-plugin-prettier.js

@@ -12,4 +12,6 @@ /**
  * @typedef {import('eslint').ESLint.Plugin} Plugin
+ * @typedef {import('eslint').ESLint.ObjectMetaProperties} ObjectMetaProperties
  * @typedef {import('prettier').FileInfoOptions} FileInfoOptions
- * @typedef {import('prettier').Options & { onDiskFilepath: string, parserPath: string, usePrettierrc?: boolean }} Options
+ * @typedef {import('prettier').Options} PrettierOptions
+ * @typedef {PrettierOptions & { onDiskFilepath: string, parserMeta?: ObjectMetaProperties['meta'], parserPath?: string, usePrettierrc?: boolean }} Options
  */
@@ -171,6 +173,8 @@
             /**
-             * @type {{}}
+             * @type {PrettierOptions}
              */
             const eslintPrettierOptions = context.options[0] || {};
 
+            const parser = context.languageOptions?.parser;
+
             // prettier.format() may throw a SyntaxError if it cannot parse the
@@ -195,2 +199,8 @@ // source code it is given. Usually for JS files this isn't a
                   onDiskFilepath,
+                  parserMeta:
+                    parser &&
+                    (parser.meta ?? {
+                      name: parser.name,
+                      version: parser.version,
+                    }),
                   parserPath: context.parserPath,
@@ -197,0 +207,0 @@ usePrettierrc,

package.json

 {
   "name": "eslint-plugin-prettier",
-  "version": "5.1.1",
+  "version": "5.1.2",
   "description": "Runs prettier as an eslint rule",
@@ -11,5 +11,5 @@ "repository": "git+https://github.com/prettier/eslint-plugin-prettier.git",
   ],
-  "funding": "https://opencollective.com/prettier",
+  "funding": "https://opencollective.com/eslint-plugin-prettier",
   "license": "MIT",
-  "packageManager": "pnpm@7.33.3",
+  "packageManager": "pnpm@7.33.5",
   "engines": {
@@ -19,2 +19,12 @@ "node": "^14.18.0 || >=16.0.0"
   "main": "eslint-plugin-prettier.js",
+  "exports": {
+    ".": {
+      "types": "./eslint-plugin-prettier.d.ts",
+      "default": "./eslint-plugin-prettier.js"
+    },
+    "./recommended": {
+      "types": "./recommended.d.ts",
+      "default": "./recommended.js"
+    }
+  },
   "types": "eslint-plugin-prettier.d.ts",
@@ -50,3 +60,3 @@ "files": [
     "prettier-linter-helpers": "^1.0.0",
-    "synckit": "^0.8.5"
+    "synckit": "^0.8.6"
   },
@@ -56,30 +66,30 @@ "devDependencies": {
     "@changesets/changelog-github": "^0.5.0",
-    "@changesets/cli": "^2.26.2",
+    "@changesets/cli": "^2.27.1",
     "@commitlint/config-conventional": "^18.4.3",
     "@eslint-community/eslint-plugin-eslint-comments": "^4.1.0",
-    "@eslint/js": "^8.55.0",
-    "@graphql-eslint/eslint-plugin": "^3.20.0",
+    "@eslint/js": "^8.56.0",
+    "@graphql-eslint/eslint-plugin": "^3.20.1",
     "@prettier/plugin-pug": "^3.0.0",
-    "@types/eslint": "^8.44.7",
-    "@types/prettier-linter-helpers": "^1.0.1",
+    "@types/eslint": "^8.56.0",
+    "@types/prettier-linter-helpers": "^1.0.4",
     "commitlint": "^18.4.3",
-    "eslint": "^8.44.0",
-    "eslint-config-prettier": "^8.8.0",
+    "eslint": "^8.56.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-formatter-friendly": "^7.0.0",
-    "eslint-mdx": "^2.1.0",
-    "eslint-plugin-eslint-plugin": "^5.1.0",
-    "eslint-plugin-mdx": "^2.2.0",
-    "eslint-plugin-n": "^16.3.1",
+    "eslint-mdx": "^2.2.1",
+    "eslint-plugin-eslint-plugin": "^5.2.1",
+    "eslint-plugin-mdx": "^2.2.1",
+    "eslint-plugin-n": "^16.5.0",
     "eslint-plugin-prettier": "link:.",
     "eslint-plugin-pug": "^1.2.5",
-    "eslint-plugin-svelte": "^2.32.2",
+    "eslint-plugin-svelte": "^2.35.1",
     "eslint-plugin-svelte3": "^4.0.0",
-    "graphql": "^16.7.1",
-    "lint-staged": "^15.1.0",
+    "graphql": "^16.8.1",
+    "lint-staged": "^15.2.0",
     "mocha": "^10.2.0",
-    "prettier": "^3.0.0",
+    "prettier": "^3.1.1",
     "prettier-plugin-pkg": "^0.18.0",
-    "simple-git-hooks": "^2.8.1",
-    "svelte": "^4.0.5",
-    "vue-eslint-parser": "^9.3.1"
+    "simple-git-hooks": "^2.9.0",
+    "svelte": "^4.2.8",
+    "vue-eslint-parser": "^9.3.2"
   },
@@ -86,0 +96,0 @@ "scripts": {

README.md

@@ -9,2 +9,17 @@ # 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)
 
+## TOC <!-- omit in toc -->
+
+- [Sample](#sample)
+- [Installation](#installation)
+- [Configuration (legacy: `.eslintrc*`)](#configuration-legacy-eslintrc)
+- [Configuration (new: `eslint.config.js`)](#configuration-new-eslintconfigjs)
+- [`Svelte` support](#svelte-support)
+- [`arrow-body-style` and `prefer-arrow-callback` issue](#arrow-body-style-and-prefer-arrow-callback-issue)
+- [Options](#options)
+- [Sponsors](#sponsors)
+- [Backers](#backers)
+- [Contributing](#contributing)
+- [Changelog](#changelog)
+- [License](#license)
+
 ## Sample
@@ -166,2 +181,14 @@
 
+## Sponsors
+
+| @prettier/plugin-eslint                                                                                                                                                        | eslint-config-prettier                                                                                                                                                       | eslint-plugin-prettier                                                                                                                                     | prettier-eslint                                                                                                                                          | prettier-eslint-cli                                                                                                                                                 |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [![@prettier/plugin-eslint Open Collective sponsors](https://opencollective.com/prettier-plugin-eslint/tiers/sponsors.svg)](https://opencollective.com/prettier-plugin-eslint) | [![eslint-config-prettier Open Collective backers](https://opencollective.com/eslint-config-prettier/tiers/sponsors.svg)](https://opencollective.com/eslint-config-prettier) | [![eslint-plugin-prettier Open Collective backers](https://opencollective.com/eslint-plugin-prettier/tiers/sponsors.svg)](https://opencollective.com/rxts) | [![prettier-eslint Open Collective sponsors](https://opencollective.com/prettier-eslint/tiers/sponsors.svg)](https://opencollective.com/prettier-eslint) | [![prettier-eslint-cli Open Collective backers](https://opencollective.com/prettier-eslint-cli/tiers/sponsors.svg)](https://opencollective.com/prettier-eslint-cli) |
+
+## Backers
+
+| @prettier/plugin-eslint                                                                                                                                                      | eslint-config-prettier                                                                                                                                                      | eslint-plugin-prettier                                                                                                                                    | prettier-eslint                                                                                                                                        | prettier-eslint-cli                                                                                                                                                |
+| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [![@prettier/plugin-eslint Open Collective backers](https://opencollective.com/prettier-plugin-eslint/tiers/backers.svg)](https://opencollective.com/prettier-plugin-eslint) | [![eslint-config-prettier Open Collective backers](https://opencollective.com/eslint-config-prettier/tiers/backers.svg)](https://opencollective.com/eslint-config-prettier) | [![eslint-plugin-prettier Open Collective backers](https://opencollective.com/eslint-plugin-prettier/tiers/backers.svg)](https://opencollective.com/rxts) | [![prettier-eslint Open Collective backers](https://opencollective.com/prettier-eslint/tiers/backers.svg)](https://opencollective.com/prettier-eslint) | [![prettier-eslint-cli Open Collective backers](https://opencollective.com/prettier-eslint-cli/tiers/backers.svg)](https://opencollective.com/prettier-eslint-cli) |
+
 ## Contributing
@@ -168,0 +195,0 @@

worker.js

@@ -5,3 +5,4 @@ // @ts-check
  * @typedef {import('prettier').FileInfoOptions} FileInfoOptions
- * @typedef {import('prettier').Options & { onDiskFilepath: string, parserPath?: string, usePrettierrc?: boolean }} Options
+ * @typedef {import('eslint').ESLint.ObjectMetaProperties} ObjectMetaProperties
+ * @typedef {import('prettier').Options & { onDiskFilepath: string, parserMeta?: ObjectMetaProperties['meta'], parserPath?: string, usePrettierrc?: boolean }} Options
  */
@@ -28,2 +29,3 @@
       onDiskFilepath,
+      parserMeta,
       parserPath,
@@ -63,3 +65,3 @@ usePrettierrc,
 
-    const initialOptions = {};
+    const initialOptions = { parser: inferredParser ?? 'babel' };
 
@@ -100,5 +102,5 @@ // ESLint supports processors that let you extract and lint JS
       // 4. `eslint-plugin-svelte3` (replacement: `eslint-plugin-svelte@2+`)
-      const parserBlocklist = [null, 'markdown', 'html'];
+      const parserBlocklist = ['html'];
 
-      let inferParserToBabel = parserBlocklist.includes(inferredParser);
+      let inferParserToBabel = parserBlocklist.includes(initialOptions.parser);
 
@@ -116,2 +118,14 @@ switch (inferredParser) {
         }
+        case 'markdown': {
+          // it could be processed by `eslint-plugin-markdown@1` or correctly parsed by `eslint-mdx`
+          if (
+            (typeof parserMeta !== 'undefined' &&
+              parserMeta.name !== 'eslint-mdx') ||
+            (typeof parserPath === 'string' &&
+              !/([\\/])eslint-mdx\1/.test(parserPath))
+          ) {
+            inferParserToBabel = true;
+          }
+          break;
+        }
         // it could be processed by `@ota-meshi/eslint-plugin-svelte`, `eslint-plugin-svelte` or `eslint-plugin-svelte3`
@@ -122,3 +136,3 @@ case 'svelte': {
             typeof parserPath === 'string' &&
-            !parserPath.includes('svelte-eslint-parser')
+            !/([\\/])svelte-eslint-parser\1/.test(parserPath)
           ) {
@@ -161,2 +175,5 @@ // We do not support `eslint-plugin-svelte3`,
 
+    /**
+     * @type {import('prettier').Options}
+     */
     const prettierOptions = {
@@ -163,0 +180,0 @@ ...initialOptions,

No alert changes

Improved metrics

Total package byte prevSize

33788

increased by25.64%

Lines of code

414

increased by6.7%

Number of lines in readme file

203

increased by15.34%

Dependency changes

• Updatedsynckit@^0.8.6