feat: add prefer-repository-shorthand rule

.vscode/settings.json

@@ -3,6 +3,7 @@
 	"editor.defaultFormatter": "esbenp.prettier-vscode",
 	"editor.formatOnSave": true,
 	"editor.rulers": [80],
+	"eslint.experimental.useFlatConfig": false,
 	"eslint.probe": [
 		"javascript",
 		"javascriptreact",

README.md

@@ -75,12 +75,13 @@ module.exports = {
 
 🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
 
-| Name                                                           | Description                                                                             | 🔧 |
-| :------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | :- |
-| [order-properties](docs/rules/order-properties.md)             | Package properties must be declared in standard order                                   | 🔧 |
-| [sort-collections](docs/rules/sort-collections.md)             | Dependencies, scripts, and configuration values must be declared in alphabetical order. | 🔧 |
-| [valid-local-dependency](docs/rules/valid-local-dependency.md) | Checks existence of local dependencies in the package.json                              |    |
-| [valid-package-def](docs/rules/valid-package-def.md)           | Enforce that package.json has all properties required by NPM spec                       |    |
+| Name                                                                     | Description                                                                             | 🔧 |
+| :----------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- | :- |
+| [order-properties](docs/rules/order-properties.md)                       | Package properties must be declared in standard order                                   | 🔧 |
+| [prefer-repository-shorthand](docs/rules/prefer-repository-shorthand.md) | Enforce shorthand declaration for GitHub repository.                                    | 🔧 |
+| [sort-collections](docs/rules/sort-collections.md)                       | Dependencies, scripts, and configuration values must be declared in alphabetical order. | 🔧 |
+| [valid-local-dependency](docs/rules/valid-local-dependency.md)           | Checks existence of local dependencies in the package.json                              |    |
+| [valid-package-def](docs/rules/valid-package-def.md)                     | Enforce that package.json has all properties required by NPM spec                       |    |
 
 <!-- end auto-generated rules list -->
 <!-- prettier-ignore-end -->

cspell.json

@@ -25,7 +25,9 @@
 		"quickstart",
 		"ruleset",
 		"tsup",
+		"vuejs",
 		"wontfix",
+		"yudai",
 		"zetlan",
 		"zetlen"
 	]

docs/rules/prefer-repository-shorthand.md

@@ -0,0 +1,28 @@
+# Enforce shorthand declaration for GitHub repository (`package-json/prefer-repository-shorthand`)
+
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
+<!-- end auto-generated rule header -->
+
+## Rule Details
+
+This rule validates url for `repository` in a `package.json` and recommends a shortened version for GitHub repositories.
+
+Examples of **incorrect** code for this rule:
+
+```json
+{
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/vuejs/core"
+	}
+}
+```
+
+Examples of **correct** code for this rule:
+
+```json
+{
+	"repository": "vuejs/core"
+}
+```

package.json

@@ -6,10 +6,7 @@
 	"bugs": {
 		"url": "https://github.com/zetlen/eslint-plugin-package-json/issues"
 	},
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/JoshuaKGoldberg/eslint-plugin-package-json"
-	},
+	"repository": "JoshuaKGoldberg/eslint-plugin-package-json",
 	"license": "MIT",
 	"author": {
 		"name": "James Zetlan",

src/index.ts

@@ -1,10 +1,12 @@
 import orderProperties from "./rules/order-properties.js";
+import preferRepositoryShorthand from "./rules/prefer-repository-shorthand.js";
 import sortCollections from "./rules/sort-collections.js";
 import validLocalDependency from "./rules/valid-local-dependency.js";
 import validPackageDef from "./rules/valid-package-def.js";
 
 export const rules = {
 	"order-properties": orderProperties,
+	"prefer-repository-shorthand": preferRepositoryShorthand,
 	"sort-collections": sortCollections,
 	"valid-local-dependency": validLocalDependency,
 	"valid-package-def": validPackageDef,

src/rules/prefer-repository-shorthand.ts

@@ -0,0 +1,103 @@
+import type ESTree from "estree";
+import type { JSONLiteral } from "jsonc-eslint-parser/lib/parser/ast.js";
+
+import { createRule } from "../createRule.js";
+
+const isGitHubUrl = (url: string) =>
+	/^(?:git\+)?(?:ssh:\/\/git@|http?s:\/\/)?(?:www\.)?github\.com\/.*\/.*/.test(
+		url,
+	);
+
+const cleanGitHubUrl = (url: string) =>
+	url
+		.replace(
+			/^(?:git\+)?(?:ssh:\/\/git@|http?s:\/\/)?(?:www\.)?github\.com\//,
+			"",
+		)
+		.replace(/\.git$/, "");
+
+export default createRule({
+	create(context) {
+		return {
+			JSONProperty: (node) => {
+				const message =
+					"Use shorthand repository URL for GitHub repository";
+				if (
+					node.key.type === "JSONLiteral" &&
+					node.key.value === "repository"
+				) {
+					if (node.value.type === "JSONObjectExpression") {
+						const { properties } = node.value;
+						const typeProperty = properties.find(
+							(property) =>
+								property.key.type === "JSONLiteral" &&
+								property.key.value === "type",
+						);
+						const urlProperty = properties.find(
+							(property) =>
+								property.key.type === "JSONLiteral" &&
+								property.key.value === "url",
+						);
+						const directoryProperty = properties.find(
+							(property) =>
+								property.key.type === "JSONLiteral" &&
+								property.key.value === "directory",
+						);
+						if (
+							!directoryProperty &&
+							typeProperty &&
+							typeProperty.value.type === "JSONLiteral" &&
+							typeProperty.value.value === "git" &&
+							urlProperty &&
+							urlProperty.value.type === "JSONLiteral" &&
+							typeof urlProperty.value.value === "string" &&
+							isGitHubUrl(urlProperty.value.value)
+						) {
+							context.report({
+								fix(fixer) {
+									return fixer.replaceText(
+										node.value as unknown as ESTree.Node,
+										JSON.stringify(
+											cleanGitHubUrl(
+												(
+													urlProperty.value as JSONLiteral
+												).value as string,
+											),
+										),
+									);
+								},
+								message,
+								node: node.value as unknown as ESTree.Node,
+							});
+						}
+					}
+
+					if (node.value.type === "JSONLiteral") {
+						const { value } = node.value;
+						if (typeof value === "string" && isGitHubUrl(value)) {
+							context.report({
+								fix(fixer) {
+									return fixer.replaceText(
+										node.value as unknown as ESTree.Node,
+										JSON.stringify(cleanGitHubUrl(value)),
+									);
+								},
+								message,
+								node: node.value as unknown as ESTree.Node,
+							});
+						}
+					}
+				}
+			},
+		};
+	},
+
+	meta: {
+		docs: {
+			category: "Best Practices",
+			description: "Enforce shorthand declaration for GitHub repository.",
+			recommended: true,
+		},
+		fixable: "code",
+	},
+});

src/tests/rules/prefer-repository-shorthand.test.ts

@@ -0,0 +1,107 @@
+import rule from "../../rules/prefer-repository-shorthand.js";
+import { ruleTester } from "./ruleTester.js";
+
+ruleTester.run("prefer-repository-shorthand", rule, {
+	invalid: [
+		{
+			code: `{
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/JoshuaKGoldberg/create-typescript-app"
+	}
+}`,
+			errors: [
+				{
+					message:
+						"Use shorthand repository URL for GitHub repository",
+					type: "JSONObjectExpression",
+				},
+			],
+			filename: "package.json",
+			output: `{
+	"repository": "JoshuaKGoldberg/create-typescript-app"
+}`,
+		},
+		{
+			code: `{
+	"repository": {
+	  "type": "git",
+	  "url": "git+https://github.com/vuejs/core.git"
+	}
+}`,
+			errors: [
+				{
+					message:
+						"Use shorthand repository URL for GitHub repository",
+					type: "JSONObjectExpression",
+				},
+			],
+			filename: "package.json",
+			output: `{
+	"repository": "vuejs/core"
+}`,
+		},
+		{
+			code: `{
+	"repository": {
+		"type": "git",
+		"url": "git+ssh://git@github.com/yudai-nkt/eslint-plugin-uvu.git"
+	}
+}`,
+			errors: [
+				{
+					message:
+						"Use shorthand repository URL for GitHub repository",
+					type: "JSONObjectExpression",
+				},
+			],
+			filename: "package.json",
+			output: `{
+	"repository": "yudai-nkt/eslint-plugin-uvu"
+}`,
+		},
+		{
+			code: `{
+	"repository": "https://github.com/eslint/eslint"
+}`,
+			errors: [
+				{
+					message:
+						"Use shorthand repository URL for GitHub repository",
+					type: "JSONLiteral",
+				},
+			],
+			filename: "package.json",
+			output: `{
+	"repository": "eslint/eslint"
+}`,
+		},
+	],
+	valid: [
+		{
+			code: `{
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/facebook/react.git",
+		"directory": "packages/react"
+	}
+}`,
+			filename: "package.json",
+		},
+		{
+			code: `{
+	"repository": "browserslist/browserslist"
+}`,
+			filename: "package.json",
+		},
+		{
+			code: `{
+	"repository": {
+		"type": "git",
+		"url": "https://gitlab.com/gitlab/gitlab"
+	}
+}`,
+			filename: "package.json",
+		},
+	],
+});