eslint-plugin-package-json 0.51.0 → 0.52.1

package/CHANGELOG.md

@@ -1,11 +1,23 @@
 # Changelog
 
-# [0.51.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.50.0...v0.51.0) (2025-08-05)
+## [0.52.1](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.52.0...v0.52.1) (2025-08-07)
+
+
+### Bug Fixes
+
+* **sort-collections:** align sorting of scripts with `prettier-plugin-packagejson` ([#1203](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1203)) ([1f5c590](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/1f5c590adc846194766127ab962f8efa72942d06)), closes [#753](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/753)
 
+# [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)
+- 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)
 

package/README.md

@@ -183,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                                        |      |    |    | ❌  |
@@ -246,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/rules/no-empty-fields.js

@@ -90,6 +90,7 @@ const rule = createRule({
     };
   },
   meta: {
+    defaultOptions: [{ ignoreProperties: [] }],
     docs: {
       category: "Best Practices",
       description: "Reports on unnecessary empty arrays and objects.",
@@ -106,6 +107,7 @@ const rule = createRule({
         additionalProperties: false,
         properties: {
           ignoreProperties: {
+            description: "Array of top-level properties to ignore.",
             items: {
               type: "string"
             },

package/lib/rules/order-properties.js

@@ -85,6 +85,7 @@ const rule = createRule({
     };
   },
   meta: {
+    defaultOptions: [{ order: "sort-package-json" }],
     docs: {
       category: "Best Practices",
       description: "Package properties must be declared in standard order",
@@ -110,7 +111,8 @@ const rule = createRule({
                 },
                 type: ["array"]
               }
-            ]
+            ],
+            description: "Specifies the sorting order of top-level properties."
           }
         },
         type: "object"

package/lib/rules/repository-shorthand.js

@@ -89,6 +89,7 @@ const rule = createRule({
     };
   },
   meta: {
+    defaultOptions: [{ form: "object" }],
     docs: {
       category: "Best Practices",
       description: "Enforce either object or shorthand declaration for repository.",
@@ -104,6 +105,7 @@ const rule = createRule({
         additionalProperties: false,
         properties: {
           form: {
+            description: "Specifies which repository form to enforce.",
             enum: ["object", "shorthand"],
             type: ["string"]
           }

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

@@ -12,21 +12,25 @@ const schemaOptions = {
   additionalProperties: false,
   properties: {
     forDependencyTypes: {
+      description: "Apply a range type restriction for an entire group of dependencies by which type of dependencies they belong to.",
       items: {
         enum: DEPENDENCY_TYPES
       },
       type: "array"
     },
     forPackages: {
+      description: "The exact name of a package, or a regex pattern used to match a group of packages by name.",
       items: {
         type: "string"
       },
       type: "array"
     },
     forVersions: {
+      description: "Apply a restriction to a specific semver range.",
       type: "string"
     },
     rangeType: {
+      description: "Identifies which range type or types you want to apply to packages that match any of the other match options (or all dependencies if no other options are provided).",
       oneOf: [
         {
           enum: RANGE_TYPES
@@ -176,6 +180,7 @@ const rule = createRule({
     };
   },
   meta: {
+    defaultOptions: [[]],
     docs: {
       description: "Restricts the range of dependencies to allow or disallow specific types of ranges."
     },
@@ -191,6 +196,7 @@ const rule = createRule({
         oneOf: [
           schemaOptions,
           {
+            description: "Array of configuration options, specifying range requirements.",
             items: schemaOptions,
             type: "array"
           }

package/lib/rules/sort-collections.js

@@ -1,3 +1,4 @@
+import sortPackageJson from "sort-package-json";
 import { createRule } from "../createRule.js";
 const defaultCollections = /* @__PURE__ */ new Set([
   "config",
@@ -37,38 +38,27 @@ const rule = createRule({
           return;
         }
         const currentOrder = collection.properties;
-        const properties = new Set(
-          currentOrder.map(
-            (prop) => prop.key.value
-          )
-        );
-        const desiredOrder = currentOrder.slice().sort((a, b) => {
-          let aKey = a.key.value;
-          let bKey = b.key.value;
-          if (keyPartsReversed.at(-1) !== "scripts") {
+        let desiredOrder;
+        if (keyPartsReversed.at(-1) !== "scripts") {
+          desiredOrder = currentOrder.slice().sort((a, b) => {
+            const aKey = a.key.value;
+            const bKey = b.key.value;
             return aKey > bKey ? 1 : -1;
-          } else {
-            let modifier = 0;
-            if (aKey.startsWith("pre") && properties.has(aKey.substring(3))) {
-              aKey = aKey.substring(3);
-              modifier -= 1;
-            } else if (aKey.startsWith("post") && properties.has(aKey.substring(4))) {
-              aKey = aKey.substring(4);
-              modifier += 1;
-            }
-            if (bKey.startsWith("pre") && properties.has(bKey.substring(3))) {
-              bKey = bKey.substring(3);
-              modifier += 1;
-            } else if (bKey.startsWith("post") && properties.has(bKey.substring(4))) {
-              bKey = bKey.substring(4);
-              modifier -= 1;
-            }
-            if (aKey === bKey) {
-              return modifier;
-            }
-            return aKey > bKey ? 1 : -1;
-          }
-        });
+          });
+        } else {
+          const scriptsSource = context.sourceCode.getText(node);
+          const minimalJson = JSON.parse(`{${scriptsSource}}`);
+          const { scripts: sortedScripts } = sortPackageJson(minimalJson);
+          const propertyNodeMap = Object.fromEntries(
+            collection.properties.map((prop) => [
+              prop.key.value,
+              prop
+            ])
+          );
+          desiredOrder = Object.keys(sortedScripts).map(
+            (prop) => propertyNodeMap[prop]
+          );
+        }
         if (currentOrder.some(
           (property, i) => desiredOrder[i] !== property
         )) {
@@ -103,6 +93,7 @@ const rule = createRule({
     };
   },
   meta: {
+    defaultOptions: [Array.from(defaultCollections)],
     docs: {
       category: "Best Practices",
       description: "Dependencies, scripts, and configuration values must be declared in alphabetical order.",
@@ -114,6 +105,7 @@ const rule = createRule({
     },
     schema: [
       {
+        description: "Array of package properties to require sorting.",
         items: {
           type: "string"
         },

package/lib/rules/valid-bin.js

@@ -51,6 +51,7 @@ const rule = createRule({
     };
   },
   meta: {
+    defaultOptions: [{ enforceCase: false }],
     docs: {
       category: "Best Practices",
       description: "Enforce that the `bin` property is valid.",
@@ -67,7 +68,7 @@ const rule = createRule({
         additionalProperties: false,
         properties: {
           enforceCase: {
-            default: false,
+            description: "Enforce that the bin's keys should be in kebab case.",
             type: "boolean"
           }
         },

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

@@ -29,6 +29,7 @@ const rule = createRule({
   },
   // eslint-disable-next-line eslint-plugin/prefer-message-ids
   meta: {
+    defaultOptions: [{ ignoreProperties: [] }],
     docs: {
       category: "Best Practices",
       description: "Enforce that package.json has all properties required by the npm spec",
@@ -39,6 +40,7 @@ const rule = createRule({
         additionalProperties: false,
         properties: {
           ignoreProperties: {
+            description: "Array of top-level package properties to ignore.",
             items: {
               type: "string"
             },

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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "eslint-plugin-package-json",
-	"version": "0.51.0",
+	"version": "0.52.1",
 	"description": "Rules for consistent, readable, and valid package.json files. 🗂️",
 	"homepage": "https://github.com/JoshuaKGoldberg/eslint-plugin-package-json#readme",
 	"bugs": {
@@ -44,16 +44,16 @@
 		"*": "prettier --ignore-unknown --write"
 	},
 	"dependencies": {
-		"@altano/repository-tools": "^2.0.0",
+		"@altano/repository-tools": "^2.0.1",
 		"change-case": "^5.4.4",
 		"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",
-		"validate-npm-package-name": "^6.0.0"
+		"sort-package-json": "^3.3.0",
+		"validate-npm-package-name": "^6.0.2"
 	},
 	"devDependencies": {
 		"@eslint-community/eslint-plugin-eslint-comments": "4.5.0",
@@ -71,7 +71,7 @@
 		"create-typescript-app": "2.46.1",
 		"eslint": "9.32.0",
 		"eslint-doc-generator": "2.2.0",
-		"eslint-plugin-eslint-plugin": "6.5.0",
+		"eslint-plugin-eslint-plugin": "7.0.0",
 		"eslint-plugin-jsdoc": "52.0.0",
 		"eslint-plugin-jsonc": "2.20.0",
 		"eslint-plugin-markdown": "5.1.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"
 	},