feat!: refactor plugin export to conform to latest conventions

This change refactors the plugin's exports to conform to the latest standards recommended by the ESLint team.

The plugin is still the default export, but it now has configs attached to it as well, but the legacy rc-based config (now called `'legacy-recommended'`) and the `recommended` flat-config.

For users of the flat config, you'll need to make the following changes.

```js
- import packageJson from "eslint-plugin-package-json/configs/recommended";
+ import packageJson from "eslint-plugin-package-json";

export default [
-	 packageJson,
+	 packageJson.configs.recommended,
];
```

For users of the legacy config, you'll need to make the following changes.

```js
module.exports = {
	overrides: [
		{
- 			extends: ["plugin:package-json/recommended"],
+ 			extends: ["plugin:package-json/legacy-recommended"],
			files: ["package.json"],
			parser: "jsonc-eslint-parser",
		},
	],
};
```

BREAKING CHANGE

Author: michaelfaith

.eslint-doc-generatorrc.js

@@ -0,0 +1,6 @@
+/** @type {import('eslint-doc-generator').GenerateOptions} */
+const config = {
+	ignoreConfig: ["legacy-recommended"],
+};
+
+module.exports = config;

README.md

@@ -34,25 +34,24 @@ This plugin's recommended configuration enables its rules on `**/package.json` f
 In your ESLint configuration file:
 
 ```ts
-import packageJson from "eslint-plugin-package-json/configs/recommended";
+import packageJson from "eslint-plugin-package-json";
 
 export default [
 	// your other ESLint configurations
-	packageJson,
+	packageJson.configs.recommended,
 ];
 ```
 
 If you want to override the recommended rules:
 
 ```ts
-import packageJson from "eslint-plugin-package-json/configs/recommended";
+import packageJson from "eslint-plugin-package-json";
 
 export default [
 	// your other ESLint configurations
+	packageJson.configs.recommended,
 	{
-		...packageJson,
 		rules: {
-			...packageJson.rules,
 			"package-json/valid-package-definition": "off",
 		},
 	},
@@ -75,10 +74,9 @@ Add an override to your ESLint configuration file that specifies `jsonc-eslint-p
 module.exports = {
 	overrides: [
 		{
-			extends: ["plugin:package-json/recommended"],
+			extends: ["plugin:package-json/legacy-recommended"],
 			files: ["package.json"],
 			parser: "jsonc-eslint-parser",
-			plugins: ["package-json"],
 		},
 	],
 };
@@ -91,10 +89,9 @@ See [ESLint's _Configure Rules_ guide](https://eslint.org/docs/latest/use/config
 module.exports = {
 	overrides: [
 		{
-			extends: ["plugin:package-json/recommended"],
+			extends: ["plugin:package-json/legacy-recommended"],
 			files: ["package.json"],
 			parser: "jsonc-eslint-parser",
-			plugins: ["package-json"],
 			rules: {
 				"package-json/valid-package-definition": "error",
 			},

eslint.config.js

@@ -44,6 +44,7 @@ module.exports = tseslint.config(
 				projectService: {
 					allowDefaultProject: [
 						"*.config.*s",
+						".eslint-doc-generatorrc.js",
 						"bin/*.js",
 						"src/tests/*.js",
 					],

package.json

@@ -21,14 +21,6 @@
 			},
 			"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.test.ts

@@ -1,12 +1,6 @@
-import { plugin, recommendedRuleSettings } from "./plugin.js";
+import { plugin } from "./plugin.js";
 
 export const rules = plugin.rules;
-
-export const configs = {
-	recommended: {
-		plugins: ["package-json"],
-		rules: recommendedRuleSettings,
-	},
-};
+export const configs = plugin.configs;
 
 export default plugin;

src/configs/recommended.ts

@@ -1,3 +1,4 @@
+import * as parserJsonc from "jsonc-eslint-parser";
 import { createRequire } from "node:module";
 
 import type { PackageJsonRuleModule } from "./createRule.js";
@@ -51,16 +52,35 @@ const rules: Record<string, PackageJsonRuleModule> = {
 	},
 };
 
+const recommendedRules = Object.fromEntries(
+	Object.entries(rules)
+		.filter(([, rule]) => rule.meta.docs?.recommended)
+		.map(([name]) => ["package-json/" + name, "error" as const]),
+);
+
 export const plugin = {
+	configs: {
+		"legacy-recommended": {
+			plugins: ["package-json"],
+			rules: recommendedRules,
+		},
+		recommended: {
+			files: ["**/package.json"],
+			languageOptions: {
+				parser: parserJsonc,
+			},
+			name: "package-json/recommended",
+			plugins: {
+				get "package-json"() {
+					return plugin;
+				},
+			},
+			rules: recommendedRules,
+		},
+	},
 	meta: {
 		name,
 		version,
 	},
 	rules,
 };
-
-export const recommendedRuleSettings = Object.fromEntries(
-	Object.entries(rules)
-		.filter(([, rule]) => rule.meta.docs?.recommended)
-		.map(([name]) => ["package-json/" + name, "error" as const]),
-);