.github/dependabot.yml

@@ -11,10 +11,20 @@ updates:
       - dependency-name: 'eslint'
       - dependency-name: 'eslint-*'
       - dependency-name: 'prettier'
+      - dependency-name: '@types/eslint'
       - dependency-name: 'vue-eslint-parser'
       - dependency-name: 'mocha'
+    groups:
+      dev-dependencies:
+        dependency-type: development
+        patterns:
+          - '*'
 
   - package-ecosystem: github-actions
     directory: /
     schedule:
       interval: monthly
+    groups:
+      actions:
+        patterns:
+          - '*'

.github/workflows/ci.yml

@@ -19,12 +19,12 @@ jobs:
           - 20
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: pnpm/action-setup@v2
 
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           cache: pnpm
@@ -36,4 +36,7 @@ jobs:
         run: pnpm mocha
 
       - name: Perf
+        # Skip on node 14, as eslint-plugin-n contains syntax that doesn't work
+        # with node 14
+        if: ${{ matrix.node-version != 14 }}
         run: TIMING=1 pnpm lint

.github/workflows/release.yml

@@ -10,11 +10,11 @@ jobs:
     name: Release
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: pnpm/action-setup@v2
 
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
           node-version: 16
           cache: pnpm

CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## 5.1.0
+
+### Minor Changes
+
+- [#616](https://github.com/prettier/eslint-plugin-prettier/pull/616) [`3856413`](https://github.com/prettier/eslint-plugin-prettier/commit/3856413420d3d026e5ae84f29c4bd0d558697135) Thanks [@BPScott](https://github.com/BPScott)! - Add recommended config for the flat config format.
+
+  If you are using flat config, import the recommended config from `eslint-plugin-prettier/recommended`. Like the legacy format recommended config, this automatically includes the contents of `eslint-config-prettier`.
+
+  ```js
+  // eslint.config.js
+  const eslintPluginPrettierRecommended = require('eslint-plugin-prettier/recommended');
+
+  module.exports = [
+    // Any other config imports go at the top
+    eslintPluginPrettierRecommended,
+  ];
+  ```
+
+### Patch Changes
+
+- [#614](https://github.com/prettier/eslint-plugin-prettier/pull/614) [`5270877`](https://github.com/prettier/eslint-plugin-prettier/commit/5270877d169bec05449861c8ad7e6338b0ad47c0) Thanks [@BPScott](https://github.com/BPScott)! - Add meta block to plugin. This improves debugging and cachebusting when using the new flat config
+
+- [#603](https://github.com/prettier/eslint-plugin-prettier/pull/603) [`a63a570`](https://github.com/prettier/eslint-plugin-prettier/commit/a63a570f8f3e3d53b90b1cf35e06fd7e3c387a5a) Thanks [@filiptammergard](https://github.com/filiptammergard)! - fix: specify `eslint-config-prettier` as peer dependency
+
+  It's already added to `peerDependenciesMeta` as optional, which means it should also be specified in `peerDependencies`.
+
 ## 5.0.1
 
 ### Patch Changes

README.md

@@ -37,63 +37,52 @@ error: Delete `;` (prettier/prettier) at pkg/commons-atom/ActiveEditorRegistry.j
 ## Installation
 
 ```sh
-npm install --save-dev eslint-plugin-prettier
+npm install --save-dev eslint-plugin-prettier eslint-config-prettier
 npm install --save-dev --save-exact prettier
 ```
 
 **_`eslint-plugin-prettier` does not install Prettier or ESLint for you._** _You must install these yourself._
 
-Then, in your `.eslintrc.json`:
+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. Our recommended configuration automatically enables [`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier) to disable all formatting-related ESLint rules.
+
+## Configuration (legacy: `.eslintrc*`)
+
+For [legacy configuration](https://eslint.org/docs/latest/use/configure/configuration-files), this plugin ships with a `plugin:prettier/recommended` config that sets up both `eslint-plugin-prettier` and [`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier) in one go.
+
+Add `plugin:prettier/recommended` as the _last_ item in the extends array in your `.eslintrc*` config file, so that `eslint-config-prettier` has the opportunity to override other configs:
 
 ```json
 {
-  "plugins": ["prettier"],
-  "rules": {
-    "prettier/prettier": "error"
-  }
+  "extends": ["plugin:prettier/recommended"]
 }
 ```
 
-## Recommended Configuration
-
-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.
-
-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`:
+This will:
 
-   ```sh
-   npm install --save-dev eslint-config-prettier
-   ```
+- Enable the `prettier/prettier` rule.
+- Disable the `arrow-body-style` and `prefer-arrow-callback` rules which are problematic with this plugin - see the below for why.
+- Enable the `eslint-config-prettier` config which will turn off ESLint rules that conflict with Prettier.
 
-2. Then you need to add `plugin:prettier/recommended` as the _last_ extension in your `.eslintrc.json`:
+## Configuration (new: `eslint.config.js`)
 
-   ```json
-   {
-     "extends": ["plugin:prettier/recommended"]
-   }
-   ```
+For [flat configuration](https://eslint.org/docs/latest/use/configure/configuration-files-new), this plugin ships with an `eslint-plugin-prettier/recommended` config that sets up both `eslint-plugin-prettier` and [`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier) in one go.
 
-   You can then set Prettier's own options inside a `.prettierrc` file.
+Import `eslint-plugin-prettier/recommended` and add it as the _last_ item in the configuration array in your `eslint.config.js` file so that `eslint-config-prettier` has the opportunity to override other configs:
 
-Exactly what does `plugin:prettier/recommended` do? Well, this is what it expands to:
+```js
+const eslintPluginPrettierRecommended = require('eslint-plugin-prettier/recommended');
 
-```json
-{
-  "extends": ["prettier"],
-  "plugins": ["prettier"],
-  "rules": {
-    "prettier/prettier": "error",
-    "arrow-body-style": "off",
-    "prefer-arrow-callback": "off"
-  }
-}
+module.exports = [
+  // Any other config imports go at the top
+  eslintPluginPrettierRecommended,
+];
 ```
 
-- `"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.
+This will:
+
+- Enable the `prettier/prettier` rule.
+- Disable the `arrow-body-style` and `prefer-arrow-callback` rules which are problematic with this plugin - see the below for why.
+- Enable the `eslint-config-prettier` config which will turn off ESLint rules that conflict with Prettier.
 
 ## `Svelte` support
 

eslint-plugin-prettier.js

@@ -23,6 +23,7 @@ const {
   showInvisibles,
   generateDifferences,
 } = require('prettier-linter-helpers');
+const { name, version } = require('./package.json');
 
 // ------------------------------------------------------------------------------
 //  Constants
@@ -54,8 +55,11 @@ let prettierFormat;
 function reportDifference(context, difference) {
   const { operation, offset, deleteText = '', insertText = '' } = difference;
   const range = /** @type {Range} */ ([offset, offset + deleteText.length]);
+  // `context.getSourceCode()` was deprecated in ESLint v8.40.0 and replaced
+  // with the `sourceCode` property.
+  // TODO: Only use property when our eslint peerDependency is >=8.40.0.
   const [start, end] = range.map(index =>
-    context.getSourceCode().getLocFromIndex(index),
+    (context.sourceCode ?? context.getSourceCode()).getLocFromIndex(index),
   );
 
   context.report({
@@ -77,6 +81,7 @@ function reportDifference(context, difference) {
  * @type {Plugin}
  */
 const eslintPluginPrettier = {
+  meta: { name, version },
   configs: {
     recommended: {
       extends: ['prettier'],
@@ -130,14 +135,26 @@ const eslintPluginPrettier = {
          */
         const fileInfoOptions =
           (context.options[1] && context.options[1].fileInfoOptions) || {};
-        const sourceCode = context.getSourceCode();
-        const filepath = context.getFilename();
+
+        // `context.getSourceCode()` was deprecated in ESLint v8.40.0 and replaced
+        // with the `sourceCode` property.
+        // TODO: Only use property when our eslint peerDependency is >=8.40.0.
+        const sourceCode = context.sourceCode ?? context.getSourceCode();
+        // `context.getFilename()` was deprecated in ESLint v8.40.0 and replaced
+        // with the `filename` property.
+        // TODO: Only use property when our eslint peerDependency is >=8.40.0.
+        const filepath = context.filename ?? 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.
-        const onDiskFilepath = context.getPhysicalFilename();
+        // `context.getPhysicalFilename()` was deprecated in ESLint v8.40.0 and replaced
+        // with the `physicalFilename` property.
+        // TODO: Only use property when our eslint peerDependency is >=8.40.0.
+        const onDiskFilepath =
+          context.physicalFilename ?? context.getPhysicalFilename();
         const source = sourceCode.text;
 
         return {

eslint.config.js

@@ -0,0 +1,46 @@
+const { configs: eslintConfigs } = require('@eslint/js');
+const eslintPluginN = require('eslint-plugin-n');
+const eslintPluginEslintComments = require('@eslint-community/eslint-plugin-eslint-comments');
+const eslintPluginEslintPluginRecommended = require('eslint-plugin-eslint-plugin/configs/recommended');
+const eslintPluginMdx = require('eslint-plugin-mdx');
+const eslintPluginPrettierRecommended = require('./recommended');
+
+module.exports = [
+  eslintConfigs.recommended,
+  eslintPluginN.configs['flat/recommended'],
+  // eslint-community/eslint-comments does not expose a reusable flat config,
+  // so create one from its legacy config
+  {
+    plugins: {
+      '@eslint-community/eslint-comments': eslintPluginEslintComments,
+    },
+    rules: eslintPluginEslintComments.configs.recommended.rules,
+  },
+  eslintPluginEslintPluginRecommended,
+  eslintPluginMdx.flat,
+  eslintPluginMdx.flatCodeBlocks,
+  eslintPluginPrettierRecommended,
+  {
+    rules: {
+      'eslint-plugin/report-message-format': ['error', '^[^a-z].*\\.$'],
+    },
+  },
+  {
+    files: ['**/*.md'],
+    rules: { 'prettier/prettier': ['error', { parser: 'markdown' }] },
+  },
+  {
+    files: ['**/*.mdx'],
+    rules: { 'prettier/prettier': ['error', { parser: 'mdx' }] },
+  },
+  // Global ignores
+  // If a config block only contains an `ignores` key, then the globs are
+  // ignored globally
+  {
+    ignores: [
+      'CHANGELOG.md',
+      '.github/ISSUE_TEMPLATE.md',
+      'test/fixtures/**/*',
+    ],
+  },
+];

package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-prettier",
-  "version": "5.0.1",
+  "version": "5.1.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",
@@ -19,6 +19,8 @@
   "files": [
     "eslint-plugin-prettier.d.ts",
     "eslint-plugin-prettier.js",
+    "recommended.d.ts",
+    "recommended.js",
     "worker.js"
   ],
   "keywords": [
@@ -38,6 +40,7 @@
   "peerDependencies": {
     "@types/eslint": ">=8.0.0",
     "eslint": ">=8.0.0",
+    "eslint-config-prettier": "*",
     "prettier": ">=3.0.0"
   },
   "peerDependenciesMeta": {
@@ -54,26 +57,27 @@
   },
   "devDependencies": {
     "@1stg/remark-preset": "^2.0.0",
-    "@changesets/changelog-github": "^0.4.8",
+    "@changesets/changelog-github": "^0.5.0",
     "@changesets/cli": "^2.26.2",
-    "@commitlint/config-conventional": "^17.6.6",
-    "@eslint-community/eslint-plugin-eslint-comments": "^3.2.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",
-    "@types/eslint": "^8.44.0",
+    "@types/eslint": "^8.44.7",
     "@types/prettier-linter-helpers": "^1.0.1",
-    "commitlint": "^17.6.6",
+    "commitlint": "^18.4.3",
     "eslint": "^8.44.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-formatter-friendly": "^7.0.0",
     "eslint-mdx": "^2.1.0",
     "eslint-plugin-eslint-plugin": "^5.1.0",
-    "eslint-plugin-mdx": "^2.1.0",
-    "eslint-plugin-n": "^16.0.1",
+    "eslint-plugin-mdx": "^2.2.0",
+    "eslint-plugin-n": "^16.3.1",
     "eslint-plugin-prettier": "link:.",
     "eslint-plugin-svelte": "^2.32.2",
     "eslint-plugin-svelte3": "^4.0.0",
     "graphql": "^16.7.1",
-    "lint-staged": "^13.2.3",
+    "lint-staged": "^15.1.0",
     "mocha": "^10.2.0",
     "prettier": "^3.0.0",
     "prettier-plugin-pkg": "^0.18.0",

recommended.d.ts

@@ -0,0 +1,5 @@
+import { Linter } from 'eslint';
+
+declare const recommendedConfig: Linter.FlatConfig;
+
+export = recommendedConfig;

recommended.js

@@ -0,0 +1,17 @@
+const eslintConfigPrettier = require('eslint-config-prettier');
+const eslintPluginPrettier = require('./eslint-plugin-prettier');
+
+// Merge the contents of eslint-config-prettier into every
+module.exports = {
+  ...eslintConfigPrettier,
+  plugins: {
+    ...eslintConfigPrettier.plugins,
+    prettier: eslintPluginPrettier,
+  },
+  rules: {
+    ...eslintConfigPrettier.rules,
+    'prettier/prettier': 'error',
+    'arrow-body-style': 'off',
+    'prefer-arrow-callback': 'off',
+  },
+};