eslint-plugin-package-json 0.50.0 → 0.52.0

package/CHANGELOG.md

@@ -1,11 +1,23 @@
 # Changelog
 
-# [0.50.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.49.0...v0.50.0) (2025-08-05)
+# [0.52.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.51.0...v0.52.0) (2025-08-07)
+
+
+### Features
+
+* **valid-description:** add new rule for validating `description` ([#1204](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1204)) ([4acb265](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/4acb26563c0cacb5834c8b53dae68fb291c0ffd1)), closes [#823](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/823)
 
+# [0.51.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.50.0...v0.51.0) (2025-08-05)
+
+### Features
+
+- add `ignorePrivate` option to all `require-*` rules ([#1158](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1158)) ([055009b](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/055009bf864c9f8db153bf0c5bb9568d023abe12)), closes [#1092](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1092)
+
+# [0.50.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.49.0...v0.50.0) (2025-08-05)
 
 ### Features
 
-* add new `require-` rules for `bugs`, `bundleDependencies`, `dependencies`, and more ([#1197](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1197)) ([0a06664](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/0a0666404d5659ea8eb8717516aa3c3b6374af26)), closes [#862](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/862) [#863](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/863) [#811](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/811) [#809](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/809) [#801](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/801) [#797](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/797)
+- add new `require-` rules for `bugs`, `bundleDependencies`, `dependencies`, and more ([#1197](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1197)) ([0a06664](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/0a0666404d5659ea8eb8717516aa3c3b6374af26)), closes [#862](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/862) [#863](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/863) [#811](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/811) [#809](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/809) [#801](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/801) [#797](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/797)
 
 # [0.49.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.48.0...v0.49.0) (2025-08-05)
 

package/README.md

@@ -101,6 +101,40 @@ module.exports = {
 };
 ```
 
+### Settings
+
+Some rules can be configured in ESLint shared settings.
+You can set them in `settings.packageJson` in an ESLint flat config.
+
+Example:
+
+```ts
+// eslint.config.ts
+import packageJson from "eslint-plugin-package-json";
+
+export default {
+	plugins: {
+		"package-json": packageJson,
+	},
+	rules: {
+		// `description` won't be required in package.json with `"private": true`
+		"package-json/require-description": "error",
+	},
+	settings: {
+		packageJson: {
+			enforceForPrivate: false,
+		},
+	},
+};
+```
+
+#### `enforceForPrivate`
+
+**Type:** `boolean`
+
+Determines whether `require-*` rules, if used, should enforce the presence of the corresponding property in package.json files with `"private": true`.
+By default, all `require-*` rules except for [`require-name`](docs/rules/require-name.md) and [`require-version`](docs/rules/require-version.md) will report if the corresponding property is missing in package.json with `"private": true`.
+
 ### Usage Alongside Prettier
 
 **[`prettier-plugin-packagejson`](https://github.com/matzkoh/prettier-plugin-packagejson)** is a [Prettier plugin](https://prettier.io/docs/en/plugins) that enforces the same `package.json` keys ordering as the [`order-properties`](docs/rules/order-properties.md) and [sort-collections](docs/rules/sort-collections.md) rules with default options.
@@ -149,6 +183,7 @@ The default settings don't conflict, and Prettier plugins can quickly fix up ord
 | [valid-config](docs/rules/valid-config.md)                                 | Enforce that the `config` property is valid.                                                      | ✔️ ✅ |    |    |    |
 | [valid-cpu](docs/rules/valid-cpu.md)                                       | Enforce that the `cpu` property is valid.                                                         | ✔️ ✅ |    |    |    |
 | [valid-dependencies](docs/rules/valid-dependencies.md)                     | Enforce that the `dependencies` property is valid.                                                | ✔️ ✅ |    |    |    |
+| [valid-description](docs/rules/valid-description.md)                       | Enforce that the `description` property is valid.                                                 | ✔️ ✅ |    |    |    |
 | [valid-devDependencies](docs/rules/valid-devDependencies.md)               | Enforce that the `devDependencies` 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                                        |      |    |    | ❌  |
@@ -212,7 +247,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></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/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

@@ -14,8 +14,20 @@ interface JsonAstBodyStatement extends ESTree.ExpressionStatement {
 interface PackageJsonAst extends AST$1.Program {
     body: [JsonAstBodyStatement];
 }
+interface PackageJsonPluginSettings {
+    /**
+     * Whether `require-*` rules, if used, should enforce the presence of
+     * the corresponding property *in package.json files with `"private": true`*.
+     *
+     * If not specified, it will not enforce the presence only of `name` and `version` properties.
+     */
+    enforceForPrivate?: boolean;
+}
 interface PackageJsonRuleContext<Options extends unknown[] = unknown[]> extends Rule.RuleContext {
     options: Options;
+    settings: {
+        packageJson?: PackageJsonPluginSettings;
+    };
     sourceCode: PackageJsonSourceCode;
 }
 interface PackageJsonRuleModule<Options extends unknown[] = unknown[]> {
@@ -30,4 +42,4 @@ declare function createRule<Options extends unknown[]>(rule: PackageJsonRuleModu
     meta: Rule.RuleMetaData;
 };
 
-export { type JsonAstBodyExpression, type JsonAstBodyProperty, type JsonAstBodyStatement, type PackageJsonAst, type PackageJsonRuleContext, type PackageJsonRuleModule, type PackageJsonSourceCode, createRule };
+export { type JsonAstBodyExpression, type JsonAstBodyProperty, type JsonAstBodyStatement, type PackageJsonAst, type PackageJsonPluginSettings, type PackageJsonRuleContext, type PackageJsonRuleModule, type PackageJsonSourceCode, createRule };

package/lib/index.d.ts

@@ -1,5 +1,6 @@
 import * as jsonc_eslint_parser from 'jsonc-eslint-parser';
 import { PackageJsonRuleModule } from './createRule.js';
+export { PackageJsonPluginSettings } from './createRule.js';
 import { plugin } from './plugin.js';
 import 'estree';
 import 'eslint';

package/lib/rules/require-properties.d.ts

@@ -1,9 +1,15 @@
-import { PackageJsonRuleModule } from '../createRule.js';
+import * as eslint from 'eslint';
+import * as jsonc_eslint_parser from 'jsonc-eslint-parser';
+import { PackageJsonRuleContext } from '../createRule.js';
 import 'estree';
-import 'eslint';
-import 'jsonc-eslint-parser';
 
-/** All require- flavor rules */
-declare const rules: Record<string, PackageJsonRuleModule<unknown[]>>;
+declare const rules: {
+    [k: string]: {
+        create(context: PackageJsonRuleContext<[({
+            ignorePrivate?: boolean;
+        } | undefined)?]>): jsonc_eslint_parser.RuleListener;
+        meta: eslint.Rule.RuleMetaData;
+    };
+};
 
 export { rules };

package/lib/rules/require-properties.js

@@ -1,31 +1,28 @@
-import { createSimpleRequirePropertyRule } from "../utils/createSimpleRequirePropertyRule.js";
+import {
+  createSimpleRequirePropertyRule
+} from "../utils/createSimpleRequirePropertyRule.js";
 const properties = [
-  ["author", false],
-  ["bugs", false],
-  ["bundleDependencies", false],
-  ["dependencies", false],
-  ["devDependencies", false],
-  ["description", true],
-  ["engines", false],
-  ["files", false],
-  ["keywords", false],
-  ["name", true],
-  ["optionalDependencies", false],
-  ["peerDependencies", false],
-  ["type", true],
-  ["types", false],
-  ["version", true]
-  // TODO: More to come!
+  ["author"],
+  ["bugs"],
+  ["bundleDependencies"],
+  ["dependencies"],
+  ["description", { isRecommended: true }],
+  ["devDependencies"],
+  ["engines"],
+  ["files"],
+  ["keywords"],
+  ["name", { ignorePrivateDefault: true, isRecommended: true }],
+  ["optionalDependencies"],
+  ["peerDependencies"],
+  ["type", { isRecommended: true }],
+  ["types"],
+  ["version", { ignorePrivateDefault: true, isRecommended: true }]
 ];
-const rules = properties.reduce(
-  (acc, [propertyName, isRecommended]) => {
-    acc[`require-${propertyName}`] = createSimpleRequirePropertyRule(
-      propertyName,
-      isRecommended
-    );
-    return acc;
-  },
-  {}
+const rules = Object.fromEntries(
+  properties.map(([propertyName, options]) => [
+    `require-${propertyName}`,
+    createSimpleRequirePropertyRule(propertyName, options)
+  ])
 );
 export {
   rules

package/lib/rules/valid-properties.js

@@ -4,6 +4,7 @@ import {
   validateConfig,
   validateCpu,
   validateDependencies,
+  validateDescription,
   validateLicense,
   validateScripts,
   validateType
@@ -23,6 +24,7 @@ const properties = [
   ["config", validateConfig],
   ["cpu", validateCpu],
   ["dependencies", validateDependencies],
+  ["description", validateDescription],
   ["devDependencies", validateDependencies],
   ["license", validateLicense],
   ["optionalDependencies", validateDependencies],

package/lib/utils/createSimpleRequirePropertyRule.d.ts

@@ -3,15 +3,28 @@ import * as jsonc_eslint_parser from 'jsonc-eslint-parser';
 import { PackageJsonRuleContext } from '../createRule.js';
 import 'estree';
 
+interface CreateRequirePropertyRuleOptions {
+    /**
+     * The default value of `ignorePrivate` rule option.
+     */
+    ignorePrivateDefault?: boolean;
+    /**
+     * Whether the rule should be included in the recommended config.
+     */
+    isRecommended?: boolean;
+}
+type Options = [{
+    ignorePrivate?: boolean;
+}?];
 /**
  * Given a top-level property name, create a rule that requires that property to be present.
  * Optionally, include it in the recommended config.
  * Note: this will only create a basic require rule, with no options.  If you need
  * to create a more complex rule, create it in its own file.
  */
-declare const createSimpleRequirePropertyRule: (propertyName: string, isRecommended?: boolean) => {
-    create(context: PackageJsonRuleContext<unknown[]>): jsonc_eslint_parser.RuleListener;
+declare const createSimpleRequirePropertyRule: (propertyName: string, { ignorePrivateDefault, isRecommended, }?: CreateRequirePropertyRuleOptions) => {
+    create(context: PackageJsonRuleContext<Options>): jsonc_eslint_parser.RuleListener;
     meta: eslint.Rule.RuleMetaData;
 };
 
-export { createSimpleRequirePropertyRule };
+export { type CreateRequirePropertyRuleOptions, createSimpleRequirePropertyRule };

package/lib/utils/createSimpleRequirePropertyRule.js

@@ -1,10 +1,20 @@
 import { createRule } from "../createRule.js";
 import { isJSONStringLiteral } from "./predicates.js";
-const createSimpleRequirePropertyRule = (propertyName, isRecommended = false) => {
+const createSimpleRequirePropertyRule = (propertyName, {
+  ignorePrivateDefault = false,
+  isRecommended
+} = {}) => {
   return 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
           )) {
@@ -25,7 +35,18 @@ const createSimpleRequirePropertyRule = (propertyName, isRecommended = false) =>
       messages: {
         missing: "Property '{{property}}' is required."
       },
-      schema: [],
+      schema: [
+        {
+          additionalProperties: false,
+          properties: {
+            ignorePrivate: {
+              default: ignorePrivateDefault,
+              type: "boolean"
+            }
+          },
+          type: "object"
+        }
+      ],
       type: "suggestion"
     }
   });

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "eslint-plugin-package-json",
-	"version": "0.50.0",
+	"version": "0.52.0",
 	"description": "Rules for consistent, readable, and valid package.json files. 🗂️",
 	"homepage": "https://github.com/JoshuaKGoldberg/eslint-plugin-package-json#readme",
 	"bugs": {
@@ -49,7 +49,7 @@
 		"detect-indent": "^7.0.1",
 		"detect-newline": "^4.0.1",
 		"eslint-fix-utils": "~0.4.0",
-		"package-json-validator": "~0.25.0",
+		"package-json-validator": "~0.27.0",
 		"semver": "^7.5.4",
 		"sort-object-keys": "^1.1.3",
 		"sort-package-json": "^3.0.0",
@@ -93,7 +93,7 @@
 		"release-it": "19.0.1",
 		"sentences-per-line": "0.3.0",
 		"tsup": "8.5.0",
-		"typescript": "5.8.2",
+		"typescript": "5.9.2",
 		"typescript-eslint": "8.38.0",
 		"vitest": "3.2.0"
 	},
@@ -101,7 +101,7 @@
 		"eslint": ">=8.0.0",
 		"jsonc-eslint-parser": "^2.0.0"
 	},
-	"packageManager": "pnpm@10.13.0",
+	"packageManager": "pnpm@10.14.0",
 	"engines": {
 		"node": "^=20.19.0 || >=22.12.0"
 	},