eslint-plugin-package-json 0.60.0 → 0.62.0

package/CHANGELOG.md

@@ -1,11 +1,23 @@
 # Changelog
 
-# [0.60.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.59.1...v0.60.0) (2025-11-03)
+# [0.62.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.61.0...v0.62.0) (2025-11-03)
+
+
+### Features
+
+* **scripts-name-casing:** add new rule ([#1344](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1344)) ([e735595](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/e735595537e6857c771eac12a1efcd55cb2d3564)), closes [#61](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/61)
 
+# [0.61.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.60.0...v0.61.0) (2025-11-03)
+
+### Features
+
+- add new stylistic config ([#1342](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1342)) ([3d01cce](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/3d01cce99a1718a7485669c7b8cf6143a255b094)), closes [#1341](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1341)
+
+# [0.60.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.59.1...v0.60.0) (2025-11-03)
 
 ### Features
 
-* **valid-author:** create more precise reports ([#1337](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1337)) ([e79ff9a](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/e79ff9ac602d85bf999686b018de6ace3a7bee36)), closes [#000](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/000)
+- **valid-author:** create more precise reports ([#1337](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1337)) ([e79ff9a](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/e79ff9ac602d85bf999686b018de6ace3a7bee36)), closes [#000](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/000)
 
 ## [0.59.1](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.59.0...v0.59.1) (2025-10-30)
 

package/README.md

@@ -28,13 +28,12 @@ npm install eslint eslint-plugin-package-json --save-dev
 
 ## Usage
 
-### Config
+### Recommended Config
 
 This plugin's recommended configuration enables its rules on `**/package.json` files, parsing them with [`jsonc-eslint-parser`](https://github.com/ota-meshi/jsonc-eslint-parser).
 
-In your ESLint configuration file:
-
 ```ts
+// eslint.config.ts
 import packageJson from "eslint-plugin-package-json";
 
 export default [
@@ -46,6 +45,7 @@ export default [
 If you want to override the recommended rules:
 
 ```ts
+// eslint.config.ts
 import packageJson from "eslint-plugin-package-json";
 
 export default [
@@ -61,7 +61,23 @@ export default [
 
 See [ESLint's _Configuration Files_ guide](https://eslint.org/docs/latest/use/configure/configuration-files-new) for details on how to customize your rules and other config settings.
 
-### Legacy Config (deprecated)
+### Stylistic Config
+
+The stylistic configuration enables sets up the parser and files similar to the recommended config, but includes rules that are more opinionated about the style of a package.json.
+This can be used in addition to the recommended config, or on its own.
+
+```ts
+// eslint.config.ts
+import packageJson from "eslint-plugin-package-json";
+
+export default [
+	// your other ESLint configurations
+	packageJson.configs.recommended,
+	packageJson.configs.stylistic,
+];
+```
+
+### Legacy Recommended Config (deprecated)
 
 Usage with ESLint's legacy ("eslintrc") format requires also installing [`jsonc-eslint-parser`](https://github.com/ota-meshi/jsonc-eslint-parser):
 
@@ -160,13 +176,14 @@ The default settings don't conflict, and Prettier plugins can quickly fix up ord
 💼 Configurations enabled in.\
 ✔️ Set in the `legacy-recommended` configuration.\
 ✅ Set in the `recommended` configuration.\
+🎨 Set in the `stylistic` configuration.\
 🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
 💡 Manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).\
 ❌ Deprecated.
 
 | Name                                                                       | Description                                                                                                 | 💼   | 🔧 | 💡 | ❌  |
 | :------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------- | :--- | :- | :- | :- |
-| [exports-subpaths-style](docs/rules/exports-subpaths-style.md)             | Enforce consistent format for the exports field (implicit or explicit subpaths).                            |      | 🔧 |    |    |
+| [exports-subpaths-style](docs/rules/exports-subpaths-style.md)             | Enforce consistent format for the exports field (implicit or explicit subpaths).                            | 🎨   | 🔧 |    |    |
 | [no-empty-fields](docs/rules/no-empty-fields.md)                           | Reports on unnecessary empty arrays and objects.                                                            | ✔️ ✅ |    | 💡 |    |
 | [no-redundant-files](docs/rules/no-redundant-files.md)                     | Prevents adding unnecessary / redundant files.                                                              | ✔️ ✅ |    | 💡 |    |
 | [order-properties](docs/rules/order-properties.md)                         | Package properties must be declared in standard order                                                       | ✔️ ✅ | 🔧 |    |    |
@@ -188,6 +205,7 @@ The default settings don't conflict, and Prettier plugins can quickly fix up ord
 | [require-types](docs/rules/require-types.md)                               | Requires the `types` property to be present.                                                                |      |    |    |    |
 | [require-version](docs/rules/require-version.md)                           | Requires the `version` property to be present.                                                              | ✔️ ✅ |    |    |    |
 | [restrict-dependency-ranges](docs/rules/restrict-dependency-ranges.md)     | Restricts the range of dependencies to allow or disallow specific types of ranges.                          |      |    | 💡 |    |
+| [scripts-name-casing](docs/rules/scripts-name-casing.md)                   | Enforce that names for `scripts` are in kebab case (optionally separated by colons).                        | 🎨   |    | 💡 |    |
 | [sort-collections](docs/rules/sort-collections.md)                         | Selected collections must be in a consistent order (lexicographical for most; lifecycle-aware for scripts). | ✔️ ✅ | 🔧 |    |    |
 | [unique-dependencies](docs/rules/unique-dependencies.md)                   | Checks a dependency isn't specified more than once (i.e. in `dependencies` and `devDependencies`)           | ✔️ ✅ |    | 💡 |    |
 | [valid-author](docs/rules/valid-author.md)                                 | Enforce that the `author` property is valid.                                                                | ✔️ ✅ |    |    |    |

package/lib/index.d.ts

@@ -30,6 +30,19 @@ declare const configs: {
       }];
     };
   };
+  stylistic: {
+    files: string[];
+    languageOptions: {
+      parser: typeof jsonc_eslint_parser0;
+    };
+    name: string;
+    plugins: {
+      readonly "package-json": eslint0.ESLint.Plugin;
+    };
+    rules: {
+      [k: string]: "error";
+    };
+  };
 };
 //#endregion
 export { type PackageJsonPluginSettings, configs, plugin as default, rules };

package/lib/plugin.d.ts

@@ -30,6 +30,19 @@ declare const plugin: {
         }];
       };
     };
+    stylistic: {
+      files: string[];
+      languageOptions: {
+        parser: typeof parserJsonc;
+      };
+      name: string;
+      plugins: {
+        readonly "package-json": ESLint.Plugin;
+      };
+      rules: {
+        [k: string]: "error";
+      };
+    };
   };
   meta: {
     name: string;

package/lib/plugin.js

@@ -5,16 +5,17 @@ import { rule as rule$3 } from "./rules/order-properties.js";
 import { rule as rule$4 } from "./rules/repository-shorthand.js";
 import { rules } from "./rules/require-properties.js";
 import { rule as rule$5 } from "./rules/restrict-dependency-ranges.js";
-import { rule as rule$6 } from "./rules/sort-collections.js";
-import { rule as rule$7 } from "./rules/unique-dependencies.js";
-import { rule as rule$8 } from "./rules/valid-author.js";
-import { rule as rule$9 } from "./rules/valid-bin.js";
-import { rule as rule$10 } from "./rules/valid-local-dependency.js";
-import { rule as rule$11 } from "./rules/valid-name.js";
-import { rule as rule$12 } from "./rules/valid-package-definition.js";
+import { rule as rule$6 } from "./rules/scripts-name-casing.js";
+import { rule as rule$7 } from "./rules/sort-collections.js";
+import { rule as rule$8 } from "./rules/unique-dependencies.js";
+import { rule as rule$9 } from "./rules/valid-author.js";
+import { rule as rule$10 } from "./rules/valid-bin.js";
+import { rule as rule$11 } from "./rules/valid-local-dependency.js";
+import { rule as rule$12 } from "./rules/valid-name.js";
+import { rule as rule$13 } from "./rules/valid-package-definition.js";
 import { rules as rules$1 } from "./rules/valid-properties.js";
-import { rule as rule$13 } from "./rules/valid-repository-directory.js";
-import { rule as rule$14 } from "./rules/valid-version.js";
+import { rule as rule$14 } from "./rules/valid-repository-directory.js";
+import { rule as rule$15 } from "./rules/valid-version.js";
 import { createRequire } from "node:module";
 import * as parserJsonc from "jsonc-eslint-parser";
 
@@ -28,22 +29,24 @@ const rules$2 = {
 	...rules,
 	"repository-shorthand": rule$4,
 	"restrict-dependency-ranges": rule$5,
-	"sort-collections": rule$6,
-	"unique-dependencies": rule$7,
+	"scripts-name-casing": rule$6,
+	"sort-collections": rule$7,
+	"unique-dependencies": rule$8,
 	...rules$1,
-	"valid-author": rule$8,
-	"valid-bin": rule$9,
-	"valid-local-dependency": rule$10,
-	"valid-name": rule$11,
-	"valid-package-definition": rule$12,
-	"valid-repository-directory": rule$13,
-	"valid-version": rule$14
+	"valid-author": rule$9,
+	"valid-bin": rule$10,
+	"valid-local-dependency": rule$11,
+	"valid-name": rule$12,
+	"valid-package-definition": rule$13,
+	"valid-repository-directory": rule$14,
+	"valid-version": rule$15
 };
-const baseRecommendedRules = { ...Object.fromEntries(Object.entries(rules$2).filter(([, rule$15]) => rule$15.meta.docs?.recommended).map(([name$1]) => ["package-json/" + name$1, "error"])) };
+const baseRecommendedRules = { ...Object.fromEntries(Object.entries(rules$2).filter(([, rule$16]) => rule$16.meta.docs?.recommended).map(([name$1]) => ["package-json/" + name$1, "error"])) };
 const recommendedRules = {
 	...baseRecommendedRules,
 	"package-json/valid-package-definition": ["error", { ignoreProperties: Object.entries(baseRecommendedRules).filter(([name$1]) => name$1.startsWith("package-json/valid-") && name$1 !== "package-json/valid-package-definition").map(([name$1]) => name$1.replace("package-json/valid-", "")) }]
 };
+const stylisticRules = { ...Object.fromEntries(Object.entries(rules$2).filter(([, rule$16]) => rule$16.meta.docs?.category === "Stylistic").map(([name$1]) => ["package-json/" + name$1, "error"])) };
 const plugin = {
 	configs: {
 		"legacy-recommended": {
@@ -58,6 +61,15 @@ const plugin = {
 				return plugin;
 			} },
 			rules: recommendedRules
+		},
+		stylistic: {
+			files: ["**/package.json"],
+			languageOptions: { parser: parserJsonc },
+			name: "package-json/stylistic",
+			plugins: { get "package-json"() {
+				return plugin;
+			} },
+			rules: stylisticRules
 		}
 	},
 	meta: {

package/lib/rules/exports-subpaths-style.js

@@ -46,7 +46,7 @@ const rule = createRule({
 	meta: {
 		defaultOptions: [{ prefer: "explicit" }],
 		docs: {
-			category: "Best Practices",
+			category: "Stylistic",
 			description: "Enforce consistent format for the exports field (implicit or explicit subpaths).",
 			recommended: false
 		},

package/lib/rules/scripts-name-casing.d.ts

@@ -0,0 +1,6 @@
+import { PackageJsonRuleModule } from "../createRule.js";
+
+//#region src/rules/scripts-name-casing.d.ts
+declare const rule: PackageJsonRuleModule<[], []>;
+//#endregion
+export { rule };

package/lib/rules/scripts-name-casing.js

@@ -0,0 +1,43 @@
+import { createRule } from "../createRule.js";
+import { kebabCase } from "change-case";
+
+//#region src/rules/scripts-name-casing.ts
+const rule = createRule({
+	create(context) {
+		return { "Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.value=scripts]"(node) {
+			if (node.value.type === "JSONObjectExpression") for (const property of node.value.properties) {
+				const key = property.key;
+				const kebabCaseKey = key.value.split(":").map((segment) => kebabCase(segment)).join(":");
+				if (kebabCaseKey !== key.value) context.report({
+					data: { property: key.value },
+					messageId: "invalidCase",
+					node: key,
+					suggest: [{
+						data: { property: key.value },
+						fix: (fixer) => {
+							return fixer.replaceText(key, JSON.stringify(kebabCaseKey));
+						},
+						messageId: "convertToKebabCase"
+					}]
+				});
+			}
+		} };
+	},
+	meta: {
+		docs: {
+			category: "Stylistic",
+			description: "Enforce that names for `scripts` are in kebab case (optionally separated by colons)."
+		},
+		hasSuggestions: true,
+		messages: {
+			convertToKebabCase: "Convert {{ property }} to kebab case.",
+			invalidCase: "Script name {{ property }} should be in kebab case."
+		},
+		schema: [],
+		type: "suggestion"
+	},
+	name: "scripts-name-casing"
+});
+
+//#endregion
+export { rule };

package/lib/rules/valid-bin.js

@@ -1,7 +1,7 @@
 import { createRule } from "../createRule.js";
 import { formatErrors } from "../utils/formatErrors.js";
-import { validateBin } from "package-json-validator";
 import { kebabCase } from "change-case";
+import { validateBin } from "package-json-validator";
 
 //#region src/rules/valid-bin.ts
 const rule = createRule({

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "eslint-plugin-package-json",
-	"version": "0.60.0",
+	"version": "0.62.0",
 	"description": "Rules for consistent, readable, and valid package.json files. 🗂️",
 	"homepage": "https://github.com/JoshuaKGoldberg/eslint-plugin-package-json#readme",
 	"bugs": {