eslint-plugin-package-json 0.45.2 → 0.47.0

package/CHANGELOG.md

@@ -1,11 +1,23 @@
 # Changelog
 
-## [0.45.2](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.45.1...v0.45.2) (2025-07-24)
+# [0.47.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.46.0...v0.47.0) (2025-07-25)
+
+
+### Features
+
+* **no-empty-fields:** Add `ignoreProperties` option ([#1186](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1186)) ([91e7156](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/91e7156d9f4569e8fee6f1124c4c1bb18ffdfbe0)), closes [#1182](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1182)
 
+# [0.46.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.45.2...v0.46.0) (2025-07-24)
+
+### Features
+
+- **valid-config:** add new rule for validating `config` ([#1179](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1179)) ([b71de96](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/b71de96a2a79a91d177ee0d734dc5f5d1d8e5b3b)), closes [#820](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/820)
+
+## [0.45.2](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.45.1...v0.45.2) (2025-07-24)
 
 ### Bug Fixes
 
-* **deps:** update dependency package-json-validator to ~0.23.0 ([#1183](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1183)) ([fbc5f29](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/fbc5f298a63a4ce58d1311502bbea9a0593173d1))
+- **deps:** update dependency package-json-validator to ~0.23.0 ([#1183](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1183)) ([fbc5f29](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/fbc5f298a63a4ce58d1311502bbea9a0593173d1))
 
 ## [0.45.1](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.45.0...v0.45.1) (2025-07-18)
 

package/README.md

@@ -140,6 +140,7 @@ The default settings don't conflict, and Prettier plugins can quickly fix up ord
 | [valid-author](docs/rules/valid-author.md)                             | Enforce that the author field is a valid npm author specification                                 | ✔️ ✅ |    |    |    |
 | [valid-bin](docs/rules/valid-bin.md)                                   | Enforce that the `bin` property is valid.                                                         | ✔️ ✅ |    | 💡 |    |
 | [valid-bundleDependencies](docs/rules/valid-bundleDependencies.md)     | Enforce that the `bundleDependencies` (or `bundledDependencies`) property is valid.               | ✔️ ✅ |    |    |    |
+| [valid-config](docs/rules/valid-config.md)                             | Enforce that the `config` property is valid.                                                      | ✔️ ✅ |    |    |    |
 | [valid-license](docs/rules/valid-license.md)                           | Enforce that the `license` property is valid.                                                     | ✔️ ✅ |    |    |    |
 | [valid-local-dependency](docs/rules/valid-local-dependency.md)         | Checks existence of local dependencies in the package.json                                        |      |    |    | ❌  |
 | [valid-name](docs/rules/valid-name.md)                                 | Enforce that package names are valid npm package names                                            | ✔️ ✅ |    |    |    |
@@ -193,7 +194,7 @@ Thanks! 🗂
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/andreww2012"><img src="https://avatars.githubusercontent.com/u/6554045?v=4?s=100" width="100px;" alt="Andrew Kazakov"/><br /><sub><b>Andrew Kazakov</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3Aandreww2012" title="Bug reports">🐛</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=andreww2012" title="Code">💻</a> <a href="#ideas-andreww2012" title="Ideas, Planning, & Feedback">🤔</a></td>
       <td align="center" valign="top" width="14.28%"><a href="http://technotes.khitrenovich.com/"><img src="https://avatars.githubusercontent.com/u/3424762?v=4?s=100" width="100px;" alt="Anton Khitrenovich"/><br /><sub><b>Anton Khitrenovich</b></sub></a><br /><a href="#ideas-khitrenovich" title="Ideas, Planning, & Feedback">🤔</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://azat.io"><img src="https://avatars.githubusercontent.com/u/5698350?v=4?s=100" width="100px;" alt="Azat S."/><br /><sub><b>Azat S.</b></sub></a><br /><a href="#ideas-azat-io" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=azat-io" title="Code">💻</a></td>
-      <td align="center" valign="top" width="14.28%"><a href="https://github.com/anomiex"><img src="https://avatars.githubusercontent.com/u/1030580?v=4?s=100" width="100px;" alt="Brad Jorsch"/><br /><sub><b>Brad Jorsch</b></sub></a><br /><a href="#ideas-anomiex" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/anomiex"><img src="https://avatars.githubusercontent.com/u/1030580?v=4?s=100" width="100px;" alt="Brad Jorsch"/><br /><sub><b>Brad Jorsch</b></sub></a><br /><a href="#ideas-anomiex" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3Aanomiex" title="Bug reports">🐛</a></td>
       <td align="center" valign="top" width="14.28%"><a href="http://www.curtisjewell.dev/"><img src="https://avatars.githubusercontent.com/u/67483?v=4?s=100" width="100px;" alt="Curtis Jewell"/><br /><sub><b>Curtis Jewell</b></sub></a><br /><a href="#ideas-csjewell" title="Ideas, Planning, & Feedback">🤔</a></td>
     </tr>
     <tr>

package/lib/plugin.js

@@ -11,6 +11,7 @@ import { rule as uniqueDependencies } from "./rules/unique-dependencies.js";
 import { rule as validAuthor } from "./rules/valid-author.js";
 import { rule as validBin } from "./rules/valid-bin.js";
 import { rule as validBundleDependencies } from "./rules/valid-bundleDependencies.js";
+import { rule as validConfig } from "./rules/valid-config.js";
 import { rule as validLicense } from "./rules/valid-license.js";
 import { rule as validLocalDependency } from "./rules/valid-local-dependency.js";
 import { rule as validName } from "./rules/valid-name.js";
@@ -33,6 +34,7 @@ const rules = {
   "valid-author": validAuthor,
   "valid-bin": validBin,
   "valid-bundleDependencies": validBundleDependencies,
+  "valid-config": validConfig,
   "valid-license": validLicense,
   "valid-local-dependency": validLocalDependency,
   "valid-name": validName,

package/lib/rules/no-empty-fields.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/no-empty-fields.js

@@ -52,17 +52,31 @@ const report = (context, node) => {
 const getNode = (node) => {
   return node.parent.type === "JSONProperty" ? node.parent : node;
 };
+const getTopLevelPropertyName = (node) => {
+  let n = node;
+  while (n.parent.parent?.parent?.type !== void 0 && n.parent.parent.parent.type !== "Program") {
+    n = n.parent;
+  }
+  return n.key.value;
+};
 const rule = createRule({
   create(context) {
+    const ignoreProperties = context.options[0]?.ignoreProperties ?? [];
     return {
       JSONArrayExpression(node) {
         if (!node.elements.length) {
-          report(context, getNode(node));
+          const topLevelProperty = getTopLevelPropertyName(node);
+          if (!ignoreProperties.includes(topLevelProperty)) {
+            report(context, getNode(node));
+          }
         }
       },
       JSONObjectExpression(node) {
         if (!node.properties.length) {
-          report(context, getNode(node));
+          const topLevelProperty = getTopLevelPropertyName(node);
+          if (!ignoreProperties.includes(topLevelProperty)) {
+            report(context, getNode(node));
+          }
         }
       }
     };
@@ -79,7 +93,20 @@ const rule = createRule({
       emptyFields: "The field '{{field}}' does nothing and can be removed.",
       remove: "Remove this empty field."
     },
-    schema: [],
+    schema: [
+      {
+        additionalProperties: false,
+        properties: {
+          ignoreProperties: {
+            items: {
+              type: "string"
+            },
+            type: "array"
+          }
+        },
+        type: "object"
+      }
+    ],
     type: "suggestion"
   }
 });

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

@@ -0,0 +1,11 @@
+import * as eslint from 'eslint';
+import * as jsonc_eslint_parser from 'jsonc-eslint-parser';
+import { PackageJsonRuleContext } from '../createRule.js';
+import 'estree';
+
+declare const rule: {
+    create(context: PackageJsonRuleContext<unknown[]>): jsonc_eslint_parser.RuleListener;
+    meta: eslint.Rule.RuleMetaData;
+};
+
+export { rule };

package/lib/rules/valid-config.js

@@ -0,0 +1,40 @@
+import { validateConfig } from "package-json-validator";
+import { createRule } from "../createRule.js";
+import { formatErrors } from "../utils/formatErrors.js";
+const rule = createRule({
+  create(context) {
+    return {
+      "Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.value=config]"(node) {
+        const valueNode = node.value;
+        const value = JSON.parse(
+          context.sourceCode.getText(valueNode)
+        );
+        const errors = validateConfig(value);
+        if (errors.length) {
+          context.report({
+            data: {
+              errors: formatErrors(errors)
+            },
+            messageId: "validationError",
+            node: valueNode
+          });
+        }
+      }
+    };
+  },
+  meta: {
+    docs: {
+      category: "Best Practices",
+      description: "Enforce that the `config` property is valid.",
+      recommended: true
+    },
+    messages: {
+      validationError: "Invalid config: {{ errors }}"
+    },
+    schema: [],
+    type: "problem"
+  }
+});
+export {
+  rule
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "eslint-plugin-package-json",
-	"version": "0.45.2",
+	"version": "0.47.0",
 	"description": "Rules for consistent, readable, and valid package.json files. 🗂️",
 	"homepage": "https://github.com/JoshuaKGoldberg/eslint-plugin-package-json#readme",
 	"bugs": {
@@ -82,7 +82,7 @@
 		"husky": "9.1.7",
 		"jiti": "2.4.2",
 		"jsonc-eslint-parser": "2.4.0",
-		"knip": "5.61.0",
+		"knip": "5.62.0",
 		"lint-staged": "16.1.0",
 		"markdownlint": "0.38.0",
 		"markdownlint-cli": "0.45.0",