feat(scripts-name-casing): add new rule (#1344)

<!-- 👋 Hi, thanks for sending a PR to eslint-plugin-package-json! 🗂 Please fill out all fields below and make sure each item is true and [x] checked. Otherwise we may not be able to review your PR. --> ## PR Checklist - [x] Addresses an existing open issue: fixes #61 - [x] That issue was marked as [`status: accepting prs`](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=is%3Aopen+is%3Aissue+label%3A%22status%3A+accepting+prs%22) - [x] Steps in [CONTRIBUTING.md](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/blob/main/.github/CONTRIBUTING.md) were taken ## Overview This change adds a new rule for enforcing that keys of the `scripts` object use `kebab-case`. This is part of the new `stylelistic` config

Author: michaelfaith

README.md

@@ -205,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. | ✔️ ✅ | | | |

docs/rules/scripts-name-casing.md

@@ -0,0 +1,32 @@
+# scripts-name-casing
+
+💼 This rule is enabled in the 🎨 `stylistic` config.
+
+💡 This rule is manually fixable by [editor suggestions](https://eslint.org/docs/latest/use/core-concepts#rule-suggestions).
+
+<!-- end auto-generated rule header -->
+
+This rule enforces that the keys of the `scripts` object (representing the commands for each script) should be in [kebab case](https://developer.mozilla.org/en-US/docs/Glossary/Kebab_case) (e.g. `"my-script"`).
+It also permits kebab case segments separated by colons (e.g. `"test:my-script"`).
+
+Example of **incorrect** code:
+
+```json
+{
+"scripts": {
+"invalidName": "node ./scripts/build.js",
+"another:invalidCommand": "node ./scripts/another.js"
+}
+}
+```
+
+Example of **correct** code:
+
+```json
+{
+"scripts": {
+"valid-command": "node ./scripts/build.js",
+"another:valid-command": "node ./scripts/another.js"
+}
+}
+```

src/plugin.ts

@@ -11,6 +11,7 @@ import { rule as orderProperties } from "./rules/order-properties.ts";
 import { rule as preferRepositoryShorthand } from "./rules/repository-shorthand.ts";
 import { rules as requireRules } from "./rules/require-properties.ts";
 import { rule as restrictDependencyRanges } from "./rules/restrict-dependency-ranges.ts";
+import { rule as scriptsNameCasing } from "./rules/scripts-name-casing.ts";
 import { rule as sortCollections } from "./rules/sort-collections.ts";
 import { rule as uniqueDependencies } from "./rules/unique-dependencies.ts";
 import { rule as validAuthor } from "./rules/valid-author.ts";
@@ -37,6 +38,7 @@ const rules: Record<string, PackageJsonRuleModule> = {
 ...requireRules,
 "repository-shorthand": preferRepositoryShorthand,
 "restrict-dependency-ranges": restrictDependencyRanges,
+"scripts-name-casing": scriptsNameCasing,
 "sort-collections": sortCollections,
 "unique-dependencies": uniqueDependencies,
 ...basicValidRules,

src/rules/scripts-name-casing.ts

@@ -0,0 +1,62 @@
+import { kebabCase } from "change-case";
+import { AST as JsonAST } from "jsonc-eslint-parser";
+
+import { createRule } from "../createRule.ts";
+
+export const rule = createRule({
+create(context) {
+return {
+"Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.value=scripts]"(
+node: JsonAST.JSONProperty,
+) {
+if (node.value.type === "JSONObjectExpression") {
+for (const property of node.value.properties) {
+const key = property.key as JsonAST.JSONStringLiteral;
+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",
+});

src/tests/rules/scripts-name-casing.test.ts

@@ -0,0 +1,61 @@
+import { rule } from "../../rules/scripts-name-casing.ts";
+import { ruleTester } from "./ruleTester.ts";
+
+ruleTester.run("scripts-name-casing", rule, {
+invalid: [
+{
+code: `{
+ "scripts": {
+ "silverMtZion": "silver-mt-zion.js",
+ "NIN": "./nin.js"
+ }
+ }`,
+errors: [
+{
+data: {
+property: "silverMtZion",
+},
+line: 3,
+messageId: "invalidCase",
+suggestions: [
+{
+messageId: "convertToKebabCase",
+output: `{
+ "scripts": {
+ "silver-mt-zion": "silver-mt-zion.js",
+ "NIN": "./nin.js"
+ }
+ }`,
+},
+],
+},
+{
+data: {
+property: "NIN",
+},
+line: 4,
+messageId: "invalidCase",
+suggestions: [
+{
+messageId: "convertToKebabCase",
+output: `{
+ "scripts": {
+ "silverMtZion": "silver-mt-zion.js",
+ "nin": "./nin.js"
+ }
+ }`,
+},
+],
+},
+],
+},
+],
+valid: [
+"{}",
+`{ "scripts": "./silver-mt-zion.js" }`,
+`{ "scripts": "silver-mt-zion.js" }`,
+`{ "scripts": { "silver-mt-zion": "./silver-mt-zion.js" } }`,
+`{ "scripts": { "silver-mt-zion": "silver-mt-zion.js", "nin": "./nin.js" } }`,
+`{ "scripts": { "silver-mt-zion": "silver-mt-zion.js", "godspeed-you:black-emperor": "./gybe.js", "n:i:n": "./nin.js" } }`,
+],
+});