eslint-plugin-package-json 0.56.2 → 0.56.3

package/CHANGELOG.md

@@ -1,11 +1,17 @@
 # Changelog
 
-## [0.56.2](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.56.1...v0.56.2) (2025-09-04)
+## [0.56.3](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.56.2...v0.56.3) (2025-09-15)
+
+
+### Bug Fixes
+
+* **plugin:** update types to be compatible with `defineConfig` ([#1245](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1245)) ([861e5e1](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/861e5e129b3a5e3455b6b2a2a26d453086f20c14)), closes [#1242](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1242)
 
+## [0.56.2](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.56.1...v0.56.2) (2025-09-04)
 
 ### Bug Fixes
 
-* improve sort-collections docs and error messages ([#1250](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1250)) ([1864376](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/1864376039db3db690423051b0dd8a2104395aa4)), closes [#1243](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1243) [#1243](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1243)
+- improve sort-collections docs and error messages ([#1250](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1250)) ([1864376](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/1864376039db3db690423051b0dd8a2104395aa4)), closes [#1243](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1243) [#1243](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1243)
 
 ## [0.56.1](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.56.0...v0.56.1) (2025-08-31)
 

package/README.md

@@ -249,7 +249,7 @@ Thanks! 🗂
       <td align="center" valign="top" width="14.28%"><a href="https://davidlj95.com"><img src="https://avatars.githubusercontent.com/u/8050648?v=4?s=100" width="100px;" alt="David LJ"/><br /><sub><b>David LJ</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=davidlj95" title="Documentation">📖</a></td>
       <td align="center" valign="top" width="14.28%"><a href="http://lishaduck.github.io"><img src="https://avatars.githubusercontent.com/u/88557639?v=4?s=100" width="100px;" alt="Eli"/><br /><sub><b>Eli</b></sub></a><br /><a href="#ideas-lishaduck" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3Alishaduck" title="Bug reports">🐛</a></td>
       <td align="center" valign="top" width="14.28%"><a href="http://heggria.site"><img src="https://avatars.githubusercontent.com/u/34475327?v=4?s=100" width="100px;" alt="Heggria"/><br /><sub><b>Heggria</b></sub></a><br /><a href="#ideas-heggria" title="Ideas, Planning, & Feedback">🤔</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Zamiell"><img src="https://avatars.githubusercontent.com/u/5511220?v=4?s=100" width="100px;" alt="James"/><br /><sub><b>James</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=Zamiell" title="Code">💻</a> <a href="#ideas-Zamiell" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/Zamiell"><img src="https://avatars.githubusercontent.com/u/5511220?v=4?s=100" width="100px;" alt="James"/><br /><sub><b>James</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=Zamiell" title="Code">💻</a> <a href="#ideas-Zamiell" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3AZamiell" title="Bug reports">🐛</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/zetlen"><img src="https://avatars.githubusercontent.com/u/1643758?v=4?s=100" width="100px;" alt="James Zetlen"/><br /><sub><b>James Zetlen</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=zetlen" title="Code">💻</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3Azetlen" title="Bug reports">🐛</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=zetlen" title="Documentation">📖</a> <a href="#infra-zetlen" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-zetlen" title="Maintenance">🚧</a> <a href="#tool-zetlen" title="Tools">🔧</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://piranna.github.io/"><img src="https://avatars.githubusercontent.com/u/532414?v=4?s=100" width="100px;" alt="Jesús Leganés-Combarro"/><br /><sub><b>Jesús Leganés-Combarro</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=piranna" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="http://www.joshuakgoldberg.com/"><img src="https://avatars.githubusercontent.com/u/3335181?v=4?s=100" width="100px;" alt="Josh Goldberg ✨"/><br /><sub><b>Josh Goldberg ✨</b></sub></a><br /><a href="#tool-JoshuaKGoldberg" title="Tools">🔧</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3AJoshuaKGoldberg" title="Bug reports">🐛</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=JoshuaKGoldberg" title="Code">💻</a> <a href="#infra-JoshuaKGoldberg" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=JoshuaKGoldberg" title="Documentation">📖</a> <a href="#maintenance-JoshuaKGoldberg" title="Maintenance">🚧</a> <a href="#ideas-JoshuaKGoldberg" title="Ideas, Planning, & Feedback">🤔</a> <a href="#content-JoshuaKGoldberg" title="Content">🖋</a> <a href="#projectManagement-JoshuaKGoldberg" title="Project Management">📆</a></td>

package/lib/createRule.d.ts

@@ -1,4 +1,4 @@
-import { AST, RuleListener } from "jsonc-eslint-parser";
+import { AST } from "jsonc-eslint-parser";
 import * as ESTree from "estree";
 import { AST as AST$1, Rule, SourceCode } from "eslint";
 
@@ -32,7 +32,7 @@ interface PackageJsonRuleContext<Options extends unknown[] = unknown[]> extends
   sourceCode: PackageJsonSourceCode;
 }
 interface PackageJsonRuleModule<Options extends unknown[] = unknown[]> {
-  create(context: PackageJsonRuleContext<Options>): RuleListener;
+  create(context: PackageJsonRuleContext<Options>): Rule.NodeListener;
   meta: Rule.RuleMetaData;
 }
 interface PackageJsonSourceCode extends SourceCode {

package/lib/index.d.ts

@@ -1,6 +1,7 @@
 import { PackageJsonPluginSettings, PackageJsonRuleModule } from "./createRule.js";
 import { plugin } from "./plugin.js";
 import * as jsonc_eslint_parser0 from "jsonc-eslint-parser";
+import * as eslint0 from "eslint";
 
 //#region src/index.d.ts
 declare const rules: Record<string, PackageJsonRuleModule<unknown[]>>;
@@ -20,14 +21,7 @@ declare const configs: {
     };
     name: string;
     plugins: {
-      readonly "package-json": {
-        configs: /*elided*/any;
-        meta: {
-          name: string;
-          version: string;
-        };
-        rules: Record<string, PackageJsonRuleModule<unknown[]>>;
-      };
+      readonly "package-json": eslint0.ESLint.Plugin;
     };
     rules: {
       "package-json/valid-package-definition": ["error", {

package/lib/plugin.d.ts

@@ -1,5 +1,6 @@
 import { PackageJsonRuleModule } from "./createRule.js";
 import * as parserJsonc from "jsonc-eslint-parser";
+import { ESLint } from "eslint";
 
 //#region src/plugin.d.ts
 declare const plugin: {
@@ -19,7 +20,7 @@ declare const plugin: {
       };
       name: string;
       plugins: {
-        readonly "package-json": /*elided*/any;
+        readonly "package-json": ESLint.Plugin;
       };
       rules: {
         "package-json/valid-package-definition": ["error", {

package/lib/plugin.js

@@ -17,8 +17,7 @@ import { createRequire } from "node:module";
 import * as parserJsonc from "jsonc-eslint-parser";
 
 //#region src/plugin.ts
-const require = createRequire(import.meta.url);
-const { name, version } = require("../package.json");
+const { name, version } = createRequire(import.meta.url)("../package.json");
 const rules$2 = {
 	"no-empty-fields": rule,
 	"no-redundant-files": rule$1,

package/lib/rules/no-redundant-files.js

@@ -73,8 +73,7 @@ const rule = createRule({
 					messageId: "unnecessaryBin"
 				}];
 				for (const validation of validations) for (const fileToCheck of validation.files) for (const [index, fileEntry] of files.entries()) if (isNotNullish(fileEntry) && isJSONStringLiteral(fileEntry)) {
-					const regex = getCachedLocalFileRegex(fileEntry.value);
-					if (regex?.test(fileToCheck)) report(files, index, validation.messageId);
+					if (getCachedLocalFileRegex(fileEntry.value)?.test(fileToCheck)) report(files, index, validation.messageId);
 				}
 			}
 		};

package/lib/rules/order-properties.js

@@ -49,8 +49,7 @@ const rule = createRule({
 			const orderedKeys = Object.keys(orderedSource);
 			const { properties } = ast.body[0].expression;
 			for (let i = 0; i < properties.length; i += 1) {
-				const property = properties[i].key;
-				const { value } = property;
+				const { value } = properties[i].key;
 				if (value === orderedKeys[i]) continue;
 				context.report({
 					data: { property: value },

package/lib/rules/restrict-dependency-ranges.js

@@ -73,8 +73,7 @@ const capitalize = (str) => {
 const rule = createRule({
 	create(context) {
 		if (!context.options[0]) return {};
-		const optionsProvided = Array.isArray(context.options[0]) ? [...context.options[0]].reverse() : [context.options[0]];
-		const optionsArray = optionsProvided.map((option) => ({
+		const optionsArray = (Array.isArray(context.options[0]) ? [...context.options[0]].reverse() : [context.options[0]]).map((option) => ({
 			...option,
 			forPackages: option.forPackages?.map((pattern) => new RegExp(pattern)),
 			rangeTypes: Array.isArray(option.rangeType) ? option.rangeType : [option.rangeType]
@@ -93,8 +92,7 @@ const rule = createRule({
 				for (const options of optionsArray) {
 					if (options.forDependencyTypes && !options.forDependencyTypes.includes(dependencyType)) continue;
 					if (options.forPackages) {
-						const isMatch = options.forPackages.some((packageNameRegex) => packageNameRegex.test(name));
-						if (!isMatch) continue;
+						if (!options.forPackages.some((packageNameRegex) => packageNameRegex.test(name))) continue;
 					}
 					if (options.forVersions && (/^workspace:[^~*]?$/.test(version) || version !== "*" && !semver.satisfies(version.replace(/(?:workspace:)?[^~]?/, ""), options.forVersions))) continue;
 					const rangeTypes = options.rangeTypes;
@@ -106,14 +104,13 @@ const rule = createRule({
 						});
 						break;
 					}
-					const rangeTypeMatch = rangeTypes.find((rangeType) => {
+					if (!rangeTypes.find((rangeType) => {
 						switch (rangeType) {
 							case "caret": return isCaretRange;
 							case "pin": return isPinned;
 							case "tilde": return isTildeRange;
 						}
-					});
-					if (!rangeTypeMatch) context.report({
+					})) context.report({
 						data: { rangeTypes: rangeTypes.join(", ") },
 						messageId: "wrongRangeType",
 						node: property.value,

package/lib/rules/valid-local-dependency.js

@@ -9,8 +9,7 @@ const linkRegex = /^link:/;
 const rule = createRule({
 	create(context) {
 		return { "Program:exit"() {
-			const original = JSON.parse(context.sourceCode.text);
-			const { dependencies, devDependencies, peerDependencies } = original;
+			const { dependencies, devDependencies, peerDependencies } = JSON.parse(context.sourceCode.text);
 			const depObjs = [
 				Object.entries(dependencies ?? {}),
 				Object.entries(peerDependencies ?? {}),

package/lib/rules/valid-package-definition.js

@@ -12,8 +12,7 @@ const rule = createRule({
 	create(context) {
 		const ignoreProperties = context.options[0]?.ignoreProperties ?? [];
 		return { "Program:exit"() {
-			const validation = validate(context.sourceCode.text);
-			const usableErrors = validation.errors?.filter((error) => {
+			const usableErrors = validate(context.sourceCode.text).errors?.filter((error) => {
 				return isUsableError(error.message) && !ignoreProperties.includes(error.field);
 			}) ?? [];
 			for (const error of usableErrors) if (error.message) context.report({

package/lib/utils/createSimpleRequirePropertyRule.js

@@ -10,39 +10,38 @@ import { isJSONStringLiteral } from "./predicates.js";
 */
 const createSimpleRequirePropertyRule = (propertyName, { ignorePrivateDefault = false, isRecommended } = {}) => {
 	const ruleName = `require-${propertyName}`;
-	const rule = createRule({
-		create(context) {
-			const enforceForPrivate = context.settings.packageJson?.enforceForPrivate;
-			const ignorePrivate = context.options[0]?.ignorePrivate ?? (typeof enforceForPrivate === "boolean" ? !enforceForPrivate : ignorePrivateDefault);
-			return { "Program > JSONExpressionStatement > JSONObjectExpression"(node) {
-				if (ignorePrivate && node.properties.some((property) => isJSONStringLiteral(property.key) && property.key.value === "private" && property.value.type === "JSONLiteral" && property.value.value === true)) return;
-				if (!node.properties.some((property) => isJSONStringLiteral(property.key) && property.key.value === propertyName)) context.report({
-					data: { property: propertyName },
-					messageId: "missing",
-					node: context.sourceCode.ast
-				});
-			} };
-		},
-		meta: {
-			docs: {
-				description: `Requires the \`${propertyName}\` property to be present.`,
-				recommended: isRecommended
-			},
-			messages: { missing: "Property '{{property}}' is required." },
-			schema: [{
-				additionalProperties: false,
-				properties: { ignorePrivate: {
-					default: ignorePrivateDefault,
-					type: "boolean"
-				} },
-				type: "object"
-			}],
-			type: "suggestion"
-		},
-		name: ruleName
-	});
 	return {
-		rule,
+		rule: createRule({
+			create(context) {
+				const enforceForPrivate = context.settings.packageJson?.enforceForPrivate;
+				const ignorePrivate = context.options[0]?.ignorePrivate ?? (typeof enforceForPrivate === "boolean" ? !enforceForPrivate : ignorePrivateDefault);
+				return { "Program > JSONExpressionStatement > JSONObjectExpression"(node) {
+					if (ignorePrivate && node.properties.some((property) => isJSONStringLiteral(property.key) && property.key.value === "private" && property.value.type === "JSONLiteral" && property.value.value === true)) return;
+					if (!node.properties.some((property) => isJSONStringLiteral(property.key) && property.key.value === propertyName)) context.report({
+						data: { property: propertyName },
+						messageId: "missing",
+						node: context.sourceCode.ast
+					});
+				} };
+			},
+			meta: {
+				docs: {
+					description: `Requires the \`${propertyName}\` property to be present.`,
+					recommended: isRecommended
+				},
+				messages: { missing: "Property '{{property}}' is required." },
+				schema: [{
+					additionalProperties: false,
+					properties: { ignorePrivate: {
+						default: ignorePrivateDefault,
+						type: "boolean"
+					} },
+					type: "object"
+				}],
+				type: "suggestion"
+			},
+			name: ruleName
+		}),
 		ruleName
 	};
 };

package/lib/utils/createSimpleValidPropertyRule.js

@@ -11,36 +11,35 @@ import { formatErrors } from "./formatErrors.js";
 const createSimpleValidPropertyRule = (propertyName, validationFunction, aliases = []) => {
 	const ruleName = `valid-${propertyName}`;
 	const propertyNames = [propertyName, ...aliases];
-	const rule = createRule({
-		create(context) {
-			return propertyNames.reduce((acc, name) => {
-				acc[`Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.value=${name}]`] = (node) => {
-					const valueNode = node.value;
-					const value = JSON.parse(context.sourceCode.getText(valueNode));
-					const errors = validationFunction(value);
-					if (errors.length) context.report({
-						data: { errors: formatErrors(errors) },
-						messageId: "validationError",
-						node: valueNode
-					});
-				};
-				return acc;
-			}, {});
-		},
-		meta: {
-			docs: {
-				category: "Best Practices",
-				description: `Enforce that the \`${propertyName}\`${aliases.length ? ` (also: ${aliases.map((alias) => `\`${alias}\``).join(", ")})` : ""} property is valid.`,
-				recommended: true
-			},
-			messages: { validationError: `Invalid ${propertyName}: {{ errors }}` },
-			schema: [],
-			type: "problem"
-		},
-		name: ruleName
-	});
 	return {
-		rule,
+		rule: createRule({
+			create(context) {
+				return propertyNames.reduce((acc, name) => {
+					acc[`Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.value=${name}]`] = (node) => {
+						const valueNode = node.value;
+						const value = JSON.parse(context.sourceCode.getText(valueNode));
+						const errors = validationFunction(value);
+						if (errors.length) context.report({
+							data: { errors: formatErrors(errors) },
+							messageId: "validationError",
+							node: valueNode
+						});
+					};
+					return acc;
+				}, {});
+			},
+			meta: {
+				docs: {
+					category: "Best Practices",
+					description: `Enforce that the \`${propertyName}\`${aliases.length ? ` (also: ${aliases.map((alias) => `\`${alias}\``).join(", ")})` : ""} property is valid.`,
+					recommended: true
+				},
+				messages: { validationError: `Invalid ${propertyName}: {{ errors }}` },
+				schema: [],
+				type: "problem"
+			},
+			name: ruleName
+		}),
 		ruleName
 	};
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "eslint-plugin-package-json",
-	"version": "0.56.2",
+	"version": "0.56.3",
 	"description": "Rules for consistent, readable, and valid package.json files. 🗂️",
 	"homepage": "https://github.com/JoshuaKGoldberg/eslint-plugin-package-json#readme",
 	"bugs": {
@@ -57,7 +57,7 @@
 	},
 	"devDependencies": {
 		"@eslint-community/eslint-plugin-eslint-comments": "4.5.0",
-		"@eslint/js": "9.34.0",
+		"@eslint/js": "9.35.0",
 		"@release-it/conventional-changelog": "10.0.0",
 		"@types/eslint-plugin-markdown": "2.0.2",
 		"@types/estree": "1.0.7",
@@ -68,10 +68,10 @@
 		"@vitest/coverage-v8": "3.2.0",
 		"@vitest/eslint-plugin": "1.3.3",
 		"console-fail-test": "0.5.0",
-		"eslint": "9.34.0",
+		"eslint": "9.35.0",
 		"eslint-doc-generator": "2.2.0",
 		"eslint-plugin-eslint-plugin": "7.0.0",
-		"eslint-plugin-jsdoc": "54.1.0",
+		"eslint-plugin-jsdoc": "54.5.0",
 		"eslint-plugin-jsonc": "2.20.0",
 		"eslint-plugin-markdown": "5.1.0",
 		"eslint-plugin-n": "17.21.0",