eslint-plugin-package-json 0.33.1 → 0.34.0

package/CHANGELOG.md

@@ -1,11 +1,23 @@
 # Changelog
 
-## [0.33.1](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.33.0...v0.33.1) (2025-06-01)
+# [0.34.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.33.2...v0.34.0) (2025-06-10)
+
+
+### Features
+
+* **valid-package-definition:** add ignoreProperties option ([#1077](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1077)) ([530e343](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/530e3430f87f21c9fadd4d511097d20e26f7190f)), closes [#1076](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1076)
 
+## [0.33.2](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.33.1...v0.33.2) (2025-06-01)
+
+### Bug Fixes
+
+- prevent `no-redundant-files` crash with wildcard and `main` field ([#1078](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1078)) ([ad4f95f](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/ad4f95f382bce8d5d0ecc79e4242596dc3eec771)), closes [#1066](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1066)
+
+## [0.33.1](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.33.0...v0.33.1) (2025-06-01)
 
 ### Bug Fixes
 
-* add CHANGELOG to package ([#1075](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1075)) ([eb13030](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/eb130302b6dfcc456dfeaf49fdfd61bd4fa495d1)), closes [#1070](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1070)
+- add CHANGELOG to package ([#1075](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1075)) ([eb13030](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/eb130302b6dfcc456dfeaf49fdfd61bd4fa495d1)), closes [#1070](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1070)
 
 # [0.33.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.32.0...v0.33.0) (2025-05-31)
 

package/lib/index.d.mts

@@ -9,7 +9,9 @@ declare const configs: {
     "legacy-recommended": {
         plugins: string[];
         rules: {
-            [k: string]: "error";
+            "package-json/valid-package-definition": ["error", {
+                ignoreProperties: string[];
+            }];
         };
     };
     recommended: {
@@ -29,7 +31,9 @@ declare const configs: {
             };
         };
         rules: {
-            [k: string]: "error";
+            "package-json/valid-package-definition": ["error", {
+                ignoreProperties: string[];
+            }];
         };
     };
 };

package/lib/index.d.ts

@@ -9,7 +9,9 @@ declare const configs: {
     "legacy-recommended": {
         plugins: string[];
         rules: {
-            [k: string]: "error";
+            "package-json/valid-package-definition": ["error", {
+                ignoreProperties: string[];
+            }];
         };
     };
     recommended: {
@@ -29,7 +31,9 @@ declare const configs: {
             };
         };
         rules: {
-            [k: string]: "error";
+            "package-json/valid-package-definition": ["error", {
+                ignoreProperties: string[];
+            }];
         };
     };
 };

package/lib/plugin.d.mts

@@ -8,7 +8,9 @@ declare const plugin: {
         "legacy-recommended": {
             plugins: string[];
             rules: {
-                [k: string]: "error";
+                "package-json/valid-package-definition": ["error", {
+                    ignoreProperties: string[];
+                }];
             };
         };
         recommended: {
@@ -21,7 +23,9 @@ declare const plugin: {
                 readonly "package-json": /*elided*/ any;
             };
             rules: {
-                [k: string]: "error";
+                "package-json/valid-package-definition": ["error", {
+                    ignoreProperties: string[];
+                }];
             };
         };
     };

package/lib/plugin.d.ts

@@ -8,7 +8,9 @@ declare const plugin: {
         "legacy-recommended": {
             plugins: string[];
             rules: {
-                [k: string]: "error";
+                "package-json/valid-package-definition": ["error", {
+                    ignoreProperties: string[];
+                }];
             };
         };
         recommended: {
@@ -21,7 +23,9 @@ declare const plugin: {
                 readonly "package-json": /*elided*/ any;
             };
             rules: {
-                [k: string]: "error";
+                "package-json/valid-package-definition": ["error", {
+                    ignoreProperties: string[];
+                }];
             };
         };
     };

package/lib/plugin.js

@@ -77,9 +77,27 @@ const rules = {
     }
   }
 };
-const recommendedRules = Object.fromEntries(
-  Object.entries(rules).filter(([, rule]) => rule.meta.docs?.recommended).map(([name2]) => ["package-json/" + name2, "error"])
-);
+const baseRecommendedRules = {
+  ...Object.fromEntries(
+    Object.entries(rules).filter(([, rule]) => rule.meta.docs?.recommended).map(([name2]) => ["package-json/" + name2, "error"])
+  )
+};
+const recommendedRules = {
+  ...baseRecommendedRules,
+  // As we add more `valid-*` rules, we should prevent this legacy rule from
+  // also reporting the same errors.
+  "package-json/valid-package-definition": [
+    "error",
+    {
+      // Create a list of properties to ignore based on the valid-* rules
+      // we currently have. Once we've fully covered what `valid-package-definition`
+      // checks, we can remove it from the `recommended` config entirely.
+      ignoreProperties: Object.entries(baseRecommendedRules).filter(
+        ([name2]) => name2.startsWith("package-json/valid-") && name2 !== "package-json/valid-package-definition"
+      ).map(([name2]) => name2.replace("package-json/valid-", ""))
+    }
+  ]
+};
 const plugin = {
   configs: {
     "legacy-recommended": {

package/lib/plugin.mjs

@@ -43,9 +43,27 @@ const rules = {
     }
   }
 };
-const recommendedRules = Object.fromEntries(
-  Object.entries(rules).filter(([, rule]) => rule.meta.docs?.recommended).map(([name2]) => ["package-json/" + name2, "error"])
-);
+const baseRecommendedRules = {
+  ...Object.fromEntries(
+    Object.entries(rules).filter(([, rule]) => rule.meta.docs?.recommended).map(([name2]) => ["package-json/" + name2, "error"])
+  )
+};
+const recommendedRules = {
+  ...baseRecommendedRules,
+  // As we add more `valid-*` rules, we should prevent this legacy rule from
+  // also reporting the same errors.
+  "package-json/valid-package-definition": [
+    "error",
+    {
+      // Create a list of properties to ignore based on the valid-* rules
+      // we currently have. Once we've fully covered what `valid-package-definition`
+      // checks, we can remove it from the `recommended` config entirely.
+      ignoreProperties: Object.entries(baseRecommendedRules).filter(
+        ([name2]) => name2.startsWith("package-json/valid-") && name2 !== "package-json/valid-package-definition"
+      ).map(([name2]) => name2.replace("package-json/valid-", ""))
+    }
+  ]
+};
 const plugin = {
   configs: {
     "legacy-recommended": {

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

@@ -30,8 +30,12 @@ const defaultFiles = [
   /^(\.\/)?README(\.|$)/i,
   /^(\.\/)?package\.json$/i
 ];
+const wildcardsRegex = /[*?[\]{}]/;
 const cachedRegex = /* @__PURE__ */ new Map();
 const getCachedLocalFileRegex = (filename) => {
+  if (wildcardsRegex.test(filename)) {
+    return null;
+  }
   const baseFilename = filename.replace("./", "");
   let regex = cachedRegex.get(baseFilename);
   if (regex) {
@@ -132,7 +136,7 @@ const rule = (0, import_createRule.createRule)({
                 const regex = getCachedLocalFileRegex(
                   fileEntry.value
                 );
-                if (regex.test(fileToCheck)) {
+                if (regex?.test(fileToCheck)) {
                   report(files, index, validation.messageId);
                 }
               }

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

@@ -7,8 +7,12 @@ const defaultFiles = [
   /^(\.\/)?README(\.|$)/i,
   /^(\.\/)?package\.json$/i
 ];
+const wildcardsRegex = /[*?[\]{}]/;
 const cachedRegex = /* @__PURE__ */ new Map();
 const getCachedLocalFileRegex = (filename) => {
+  if (wildcardsRegex.test(filename)) {
+    return null;
+  }
   const baseFilename = filename.replace("./", "");
   let regex = cachedRegex.get(baseFilename);
   if (regex) {
@@ -109,7 +113,7 @@ const rule = createRule({
                 const regex = getCachedLocalFileRegex(
                   fileEntry.value
                 );
-                if (regex.test(fileToCheck)) {
+                if (regex?.test(fileToCheck)) {
                   report(files, index, validation.messageId);
                 }
               }

package/lib/rules/valid-package-definition.d.mts

@@ -3,8 +3,12 @@ import * as jsonc_eslint_parser from 'jsonc-eslint-parser';
 import { PackageJsonRuleContext } from '../createRule.mjs';
 import 'estree';
 
+interface Option {
+    ignoreProperties?: string[];
+}
+type Options = [Option?];
 declare const rule: {
-    create(context: PackageJsonRuleContext<unknown[]>): jsonc_eslint_parser.RuleListener;
+    create(context: PackageJsonRuleContext<Options>): jsonc_eslint_parser.RuleListener;
     meta: eslint.Rule.RuleMetaData;
 };
 

package/lib/rules/valid-package-definition.d.ts

@@ -3,8 +3,12 @@ import * as jsonc_eslint_parser from 'jsonc-eslint-parser';
 import { PackageJsonRuleContext } from '../createRule.js';
 import 'estree';
 
+interface Option {
+    ignoreProperties?: string[];
+}
+type Options = [Option?];
 declare const rule: {
-    create(context: PackageJsonRuleContext<unknown[]>): jsonc_eslint_parser.RuleListener;
+    create(context: PackageJsonRuleContext<Options>): jsonc_eslint_parser.RuleListener;
     meta: eslint.Rule.RuleMetaData;
 };
 

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

@@ -31,18 +31,22 @@ const ignoredErrors = [
 const isUsableError = (errorText) => ignoredErrors.every((pattern) => !pattern.test(errorText));
 const rule = (0, import_createRule.createRule)({
   create(context) {
+    const ignoreProperties = context.options[0]?.ignoreProperties ?? [];
     return {
       "Program:exit"() {
         const validation = (0, import_package_json_validator.validate)(context.sourceCode.text);
-        validation.errors?.filter(isUsableError).forEach((message) => {
-          if (message) {
+        const usableErrors = validation.errors?.filter((error) => {
+          return isUsableError(error.message) && !ignoreProperties.includes(error.field);
+        }) ?? [];
+        for (const error of usableErrors) {
+          if (error.message) {
             context.report({
               // eslint-disable-next-line eslint-plugin/prefer-message-ids
-              message,
+              message: error.message,
               node: context.sourceCode.ast
             });
           }
-        });
+        }
       }
     };
   },
@@ -53,7 +57,20 @@ const rule = (0, import_createRule.createRule)({
       description: "Enforce that package.json has all properties required by the npm spec",
       recommended: true
     },
-    schema: [],
+    schema: [
+      {
+        additionalProperties: false,
+        properties: {
+          ignoreProperties: {
+            items: {
+              type: "string"
+            },
+            type: "array"
+          }
+        },
+        type: "object"
+      }
+    ],
     type: "problem"
   }
 });

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

@@ -8,18 +8,22 @@ const ignoredErrors = [
 const isUsableError = (errorText) => ignoredErrors.every((pattern) => !pattern.test(errorText));
 const rule = createRule({
   create(context) {
+    const ignoreProperties = context.options[0]?.ignoreProperties ?? [];
     return {
       "Program:exit"() {
         const validation = validate(context.sourceCode.text);
-        validation.errors?.filter(isUsableError).forEach((message) => {
-          if (message) {
+        const usableErrors = validation.errors?.filter((error) => {
+          return isUsableError(error.message) && !ignoreProperties.includes(error.field);
+        }) ?? [];
+        for (const error of usableErrors) {
+          if (error.message) {
             context.report({
               // eslint-disable-next-line eslint-plugin/prefer-message-ids
-              message,
+              message: error.message,
               node: context.sourceCode.ast
             });
           }
-        });
+        }
       }
     };
   },
@@ -30,7 +34,20 @@ const rule = createRule({
       description: "Enforce that package.json has all properties required by the npm spec",
       recommended: true
     },
-    schema: [],
+    schema: [
+      {
+        additionalProperties: false,
+        properties: {
+          ignoreProperties: {
+            items: {
+              type: "string"
+            },
+            type: "array"
+          }
+        },
+        type: "object"
+      }
+    ],
     type: "problem"
   }
 });

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "eslint-plugin-package-json",
-	"version": "0.33.1",
+	"version": "0.34.0",
 	"description": "Rules for consistent, readable, and valid package.json files. 🗂️",
 	"homepage": "https://github.com/JoshuaKGoldberg/eslint-plugin-package-json#readme",
 	"bugs": {
@@ -43,7 +43,7 @@
 		"lint:spelling": "cspell \"**\" \".github/**/*\"",
 		"prepare": "husky",
 		"test": "vitest",
-		"tsc": "tsc"
+		"typecheck": "tsc"
 	},
 	"lint-staged": {
 		"*": "prettier --ignore-unknown --write"
@@ -53,7 +53,7 @@
 		"detect-indent": "6.1.0",
 		"detect-newline": "3.1.0",
 		"eslint-fix-utils": "^0.2.0",
-		"package-json-validator": "^0.10.0",
+		"package-json-validator": "~0.13.1",
 		"semver": "^7.5.4",
 		"sort-object-keys": "^1.1.3",
 		"sort-package-json": "^3.0.0",
@@ -61,7 +61,7 @@
 	},
 	"devDependencies": {
 		"@eslint-community/eslint-plugin-eslint-comments": "4.5.0",
-		"@eslint/js": "9.27.0",
+		"@eslint/js": "9.28.0",
 		"@release-it/conventional-changelog": "10.0.0",
 		"@types/eslint-plugin-markdown": "2.0.2",
 		"@types/estree": "1.0.7",
@@ -69,25 +69,25 @@
 		"@types/semver": "7.7.0",
 		"@types/sort-object-keys": "1.1.3",
 		"@types/validate-npm-package-name": "4.0.2",
-		"@vitest/coverage-v8": "3.1.2",
+		"@vitest/coverage-v8": "3.2.0",
 		"@vitest/eslint-plugin": "1.2.0",
 		"console-fail-test": "0.5.0",
 		"create-typescript-app": "2.42.0",
 		"cspell": "8.19.0",
-		"eslint": "9.27.0",
+		"eslint": "9.28.0",
 		"eslint-doc-generator": "2.1.2",
 		"eslint-plugin-eslint-plugin": "6.4.0",
-		"eslint-plugin-jsdoc": "50.6.8",
+		"eslint-plugin-jsdoc": "50.7.0",
 		"eslint-plugin-jsonc": "2.20.0",
 		"eslint-plugin-markdown": "5.1.0",
-		"eslint-plugin-n": "17.16.2",
+		"eslint-plugin-n": "17.19.0",
 		"eslint-plugin-perfectionist": "4.13.0",
 		"eslint-plugin-regexp": "2.7.0",
 		"eslint-plugin-yml": "1.18.0",
 		"husky": "9.1.7",
 		"jsonc-eslint-parser": "2.4.0",
-		"knip": "5.58.0",
-		"lint-staged": "16.0.0",
+		"knip": "5.59.0",
+		"lint-staged": "16.1.0",
 		"markdownlint": "0.38.0",
 		"markdownlint-cli": "0.45.0",
 		"prettier": "3.5.3",
@@ -98,8 +98,8 @@
 		"sentences-per-line": "0.3.0",
 		"tsup": "8.5.0",
 		"typescript": "5.8.2",
-		"typescript-eslint": "8.32.0",
-		"vitest": "3.1.2"
+		"typescript-eslint": "8.33.0",
+		"vitest": "3.2.0"
 	},
 	"peerDependencies": {
 		"eslint": ">=8.0.0",