feat: support flat config

.eslintrc.cjs

@@ -47,7 +47,7 @@ module.exports = {
 			},
 		},
 		{
-			files: "**/*.md/*.ts",
+			files: ["**/*.md/*.ts", "**/*.md/*.js"],
 			rules: {
 				"n/no-missing-import": [
 					"error",

README.md

@@ -27,6 +27,38 @@ npm install eslint eslint-plugin-package-json jsonc-eslint-parser --save-dev
 
 ## Usage
 
+### Flat Config
+
+In your ESLint configuration file:
+
+```js
+import packageJson from "eslint-plugin-package-json/configs/recommended";
+
+export default [
+	// your other ESLint configurations
+	packageJson,
+];
+```
+
+If you want to override the recommended rules:
+
+```js
+import packageJson from "eslint-plugin-package-json/configs/recommended";
+
+export default [
+	// your other ESLint configurations
+	{
+		...packageJson,
+		rules: {
+			...packageJson.rules,
+			"package-json/valid-package-def": "off",
+		},
+	},
+];
+```
+
+### Legacy Config
+
 Add an override to your ESLint configuration file that specifies this plugin, [`jsonc-eslint-parser`](https://github.com/ota-meshi/jsonc-eslint-parser), and its recommended rules for your `package.json` file:
 
 ```js
@@ -75,7 +107,7 @@ The default settings don't conflict, and Prettier plugins can quickly fix up ord
 💼 Configurations enabled in.\
 ✅ Set in the `recommended` configuration.\
 🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
-💡 Manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+💡 Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 | Name                                                                     | Description                                                                                     | 💼 | 🔧 | 💡 |
 | :----------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------- | :- | :- | :- |

docs/rules/unique-dependencies.md

@@ -2,6 +2,6 @@
 
 💼 This rule is enabled in the ✅ `recommended` config.
 
-💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 <!-- end auto-generated rule header -->

docs/rules/valid-name.md

@@ -2,7 +2,7 @@
 
 💼 This rule is enabled in the ✅ `recommended` config.
 
-💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 <!-- end auto-generated rule header -->
 

docs/rules/valid-repository-directory.md

@@ -2,7 +2,7 @@
 
 💼 This rule is enabled in the ✅ `recommended` config.
 
-💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 <!-- end auto-generated rule header -->
 

docs/rules/valid-version.md

@@ -2,7 +2,7 @@
 
 💼 This rule is enabled in the ✅ `recommended` config.
 
-💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/developer-guide/working-with-rules#providing-suggestions).
+💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
 
 <!-- end auto-generated rule header -->
 

package.json

@@ -21,6 +21,14 @@
 			},
 			"import": "./lib/index.mjs",
 			"require": "./lib/index.js"
+		},
+		"./configs/recommended": {
+			"types": {
+				"import": "./lib/configs/recommended.d.mts",
+				"require": "./lib/configs/recommended.d.ts"
+			},
+			"import": "./lib/configs/recommended.mjs",
+			"require": "./lib/configs/recommended.js"
 		}
 	},
 	"main": "./lib/index.js",

src/configs/recommended.ts

@@ -0,0 +1,18 @@
+import * as parserJsonc from "jsonc-eslint-parser";
+
+import { plugin, recommendedRuleSettings } from "../plugin.js";
+
+const recommended = {
+	files: ["**/package.json"],
+	languageOptions: {
+		parser: parserJsonc,
+	},
+	plugins: {
+		get "package-json"() {
+			return plugin;
+		},
+	},
+	rules: recommendedRuleSettings,
+};
+
+export default recommended;

src/index.ts

@@ -1,31 +1,9 @@
-import { rule as orderProperties } from "./rules/order-properties.js";
-import { rule as preferRepositoryShorthand } from "./rules/prefer-repository-shorthand.js";
-import { rule as sortCollections } from "./rules/sort-collections.js";
-import { rule as uniqueDependencies } from "./rules/unique-dependencies.js";
-import { rule as validLocalDependency } from "./rules/valid-local-dependency.js";
-import { rule as validName } from "./rules/valid-name.js";
-import { rule as validPackageDef } from "./rules/valid-package-def.js";
-import { rule as validRepositoryDirectory } from "./rules/valid-repository-directory.js";
-import { rule as validVersion } from "./rules/valid-version.js";
-
-export const rules = {
-	"order-properties": orderProperties,
-	"prefer-repository-shorthand": preferRepositoryShorthand,
-	"sort-collections": sortCollections,
-	"unique-dependencies": uniqueDependencies,
-	"valid-local-dependency": validLocalDependency,
-	"valid-name": validName,
-	"valid-package-def": validPackageDef,
-	"valid-repository-directory": validRepositoryDirectory,
-	"valid-version": validVersion,
-};
+import { plugin, recommendedRuleSettings } from "./plugin.js";
 
+export const rules = plugin.rules;
 export const configs = {
 	recommended: {
-		rules: Object.fromEntries(
-			Object.entries(rules)
-				.filter(([, rule]) => rule.meta.docs?.recommended)
-				.map(([name]) => ["package-json/" + name, "error" as const]),
-		),
+		plugins: ["package-json"],
+		rules: recommendedRuleSettings,
 	},
 };

src/plugin.ts

@@ -0,0 +1,44 @@
+import { createRequire } from "node:module";
+
+import { rule as orderProperties } from "./rules/order-properties.js";
+import { rule as preferRepositoryShorthand } from "./rules/prefer-repository-shorthand.js";
+import { rule as sortCollections } from "./rules/sort-collections.js";
+import { rule as uniqueDependencies } from "./rules/unique-dependencies.js";
+import { rule as validLocalDependency } from "./rules/valid-local-dependency.js";
+import { rule as validName } from "./rules/valid-name.js";
+import { rule as validPackageDef } from "./rules/valid-package-def.js";
+import { rule as validRepositoryDirectory } from "./rules/valid-repository-directory.js";
+import { rule as validVersion } from "./rules/valid-version.js";
+
+const require = createRequire(import.meta.url || __filename);
+
+const { name, version } = require("../package.json") as {
+	name: string;
+	version: string;
+};
+
+const allRules = {
+	"order-properties": orderProperties,
+	"prefer-repository-shorthand": preferRepositoryShorthand,
+	"sort-collections": sortCollections,
+	"unique-dependencies": uniqueDependencies,
+	"valid-local-dependency": validLocalDependency,
+	"valid-name": validName,
+	"valid-package-def": validPackageDef,
+	"valid-repository-directory": validRepositoryDirectory,
+	"valid-version": validVersion,
+};
+
+export const plugin = {
+	meta: {
+		name,
+		version,
+	},
+	rules: allRules,
+};
+
+export const recommendedRuleSettings = Object.fromEntries(
+	Object.entries(allRules)
+		.filter(([, rule]) => rule.meta.docs?.recommended)
+		.map(([name]) => ["package-json/" + name, "error" as const]),
+);