eslint-plugin-package-json 0.4.0 → 0.5.0

package/README.md

@@ -6,7 +6,7 @@
 	<a href="#contributors" target="_blank">
 <!-- prettier-ignore-start -->
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-<img alt="All Contributors: 8 👪" src="https://img.shields.io/badge/all_contributors-8_👪-21bb42.svg" />
+<img alt="All Contributors: 13 👪" src="https://img.shields.io/badge/all_contributors-13_👪-21bb42.svg" />
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 <!-- prettier-ignore-end -->
 </a>
@@ -73,14 +73,17 @@ module.exports = {
 <!-- prettier-ignore-start -->
 <!-- begin auto-generated rules list -->
 
+💼 Configurations enabled in.\
+✅ Set in the `recommended` configuration.\
 🔧 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 -->
@@ -96,15 +99,20 @@ These rules only run on `package.json` files; they will ignore all other files b
 <table>
   <tbody>
     <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/AndreasLindbergPAF"><img src="https://avatars.githubusercontent.com/u/59874563?v=4?s=100" width="100px;" alt="Andreas Lindberg"/><br /><sub><b>Andreas Lindberg</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3Aandreaslindbergpaf" title="Bug reports">🐛</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://technotes.khitrenovich.com/"><img src="https://avatars.githubusercontent.com/u/3424762?v=4?s=100" width="100px;" alt="Anton Khitrenovich"/><br /><sub><b>Anton Khitrenovich</b></sub></a><br /><a href="#ideas-khitrenovich" title="Ideas, Planning, & Feedback">🤔</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://azat.io"><img src="https://avatars.githubusercontent.com/u/5698350?v=4?s=100" width="100px;" alt="Azat S."/><br /><sub><b>Azat S.</b></sub></a><br /><a href="#ideas-azat-io" 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/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></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></td>
+    </tr>
+    <tr>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/kendallgassner"><img src="https://avatars.githubusercontent.com/u/15275462?v=4?s=100" width="100px;" alt="Kendall Gassner"/><br /><sub><b>Kendall Gassner</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=kendallgassner" title="Code">💻</a> <a href="#maintenance-kendallgassner" title="Maintenance">🚧</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/KristjanESPERANTO"><img src="https://avatars.githubusercontent.com/u/35647502?v=4?s=100" width="100px;" alt="Kristjan ESPERANTO"/><br /><sub><b>Kristjan ESPERANTO</b></sub></a><br /><a href="#ideas-kristjanesperanto" title="Ideas, Planning, & Feedback">🤔</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/nschonni"><img src="https://avatars.githubusercontent.com/u/1297909?v=4?s=100" width="100px;" alt="Nick Schonning"/><br /><sub><b>Nick Schonning</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=nschonni" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/sirugh"><img src="https://avatars.githubusercontent.com/u/1278869?v=4?s=100" width="100px;" alt="Stephen"/><br /><sub><b>Stephen</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=sirugh" title="Code">💻</a></td>
-    </tr>
-    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://ota-meshi.github.io/"><img src="https://avatars.githubusercontent.com/u/16508807?v=4?s=100" width="100px;" alt="Yosuke Ota"/><br /><sub><b>Yosuke Ota</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3Aota-meshi" title="Bug reports">🐛</a> <a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commits?author=ota-meshi" title="Code">💻</a></td>
       <td align="center" valign="top" width="14.28%"><a href="https://github.com/b3rnhard"><img src="https://avatars.githubusercontent.com/u/10774404?v=4?s=100" width="100px;" alt="b3rnhard"/><br /><sub><b>b3rnhard</b></sub></a><br /><a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues?q=author%3Ab3rnhard" title="Bug reports">🐛</a></td>
     </tr>
   </tbody>

package/lib/index.d.mts

@@ -10,6 +10,10 @@ declare const rules: {
         } | undefined)?]>): jsonc_eslint_parser.RuleListener;
         meta: eslint.Rule.RuleMetaData;
     };
+    "prefer-repository-shorthand": {
+        create(context: PackageJsonRuleContext<unknown[]>): jsonc_eslint_parser.RuleListener;
+        meta: eslint.Rule.RuleMetaData;
+    };
     "sort-collections": {
         create(context: PackageJsonRuleContext<string[]>): jsonc_eslint_parser.RuleListener;
         meta: eslint.Rule.RuleMetaData;

package/lib/index.d.ts

@@ -10,6 +10,10 @@ declare const rules: {
         } | undefined)?]>): jsonc_eslint_parser.RuleListener;
         meta: eslint.Rule.RuleMetaData;
     };
+    "prefer-repository-shorthand": {
+        create(context: PackageJsonRuleContext<unknown[]>): jsonc_eslint_parser.RuleListener;
+        meta: eslint.Rule.RuleMetaData;
+    };
     "sort-collections": {
         create(context: PackageJsonRuleContext<string[]>): jsonc_eslint_parser.RuleListener;
         meta: eslint.Rule.RuleMetaData;

package/lib/index.js

@@ -33,11 +33,13 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 var import_order_properties = __toESM(require("./rules/order-properties.js"));
+var import_prefer_repository_shorthand = __toESM(require("./rules/prefer-repository-shorthand.js"));
 var import_sort_collections = __toESM(require("./rules/sort-collections.js"));
 var import_valid_local_dependency = __toESM(require("./rules/valid-local-dependency.js"));
 var import_valid_package_def = __toESM(require("./rules/valid-package-def.js"));
 const rules = {
   "order-properties": import_order_properties.default,
+  "prefer-repository-shorthand": import_prefer_repository_shorthand.default,
   "sort-collections": import_sort_collections.default,
   "valid-local-dependency": import_valid_local_dependency.default,
   "valid-package-def": import_valid_package_def.default

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import orderProperties from \"./rules/order-properties.js\";\nimport sortCollections from \"./rules/sort-collections.js\";\nimport validLocalDependency from \"./rules/valid-local-dependency.js\";\nimport validPackageDef from \"./rules/valid-package-def.js\";\n\nexport const rules = {\n\t\"order-properties\": orderProperties,\n\t\"sort-collections\": sortCollections,\n\t\"valid-local-dependency\": validLocalDependency,\n\t\"valid-package-def\": validPackageDef,\n};\n\nexport const configs = {\n\trecommended: {\n\t\trules: Object.fromEntries(\n\t\t\tObject.entries(rules)\n\t\t\t\t.filter(([, rule]) => rule.meta.docs?.recommended)\n\t\t\t\t.map(([name]) => [\"package-json/\" + name, \"error\" as const]),\n\t\t),\n\t},\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,8BAA4B;AAC5B,8BAA4B;AAC5B,oCAAiC;AACjC,+BAA4B;AAErB,MAAM,QAAQ;AAAA,EACpB,oBAAoB,wBAAAA;AAAA,EACpB,oBAAoB,wBAAAC;AAAA,EACpB,0BAA0B,8BAAAC;AAAA,EAC1B,qBAAqB,yBAAAC;AACtB;AAEO,MAAM,UAAU;AAAA,EACtB,aAAa;AAAA,IACZ,OAAO,OAAO;AAAA,MACb,OAAO,QAAQ,KAAK,EAClB,OAAO,CAAC,CAAC,EAAE,IAAI,MAAM,KAAK,KAAK,MAAM,WAAW,EAChD,IAAI,CAAC,CAAC,IAAI,MAAM,CAAC,kBAAkB,MAAM,OAAgB,CAAC;AAAA,IAC7D;AAAA,EACD;AACD;","names":["orderProperties","sortCollections","validLocalDependency","validPackageDef"]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import orderProperties from \"./rules/order-properties.js\";\nimport preferRepositoryShorthand from \"./rules/prefer-repository-shorthand.js\";\nimport sortCollections from \"./rules/sort-collections.js\";\nimport validLocalDependency from \"./rules/valid-local-dependency.js\";\nimport validPackageDef from \"./rules/valid-package-def.js\";\n\nexport const rules = {\n\t\"order-properties\": orderProperties,\n\t\"prefer-repository-shorthand\": preferRepositoryShorthand,\n\t\"sort-collections\": sortCollections,\n\t\"valid-local-dependency\": validLocalDependency,\n\t\"valid-package-def\": validPackageDef,\n};\n\nexport const configs = {\n\trecommended: {\n\t\trules: Object.fromEntries(\n\t\t\tObject.entries(rules)\n\t\t\t\t.filter(([, rule]) => rule.meta.docs?.recommended)\n\t\t\t\t.map(([name]) => [\"package-json/\" + name, \"error\" as const]),\n\t\t),\n\t},\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,8BAA4B;AAC5B,yCAAsC;AACtC,8BAA4B;AAC5B,oCAAiC;AACjC,+BAA4B;AAErB,MAAM,QAAQ;AAAA,EACpB,oBAAoB,wBAAAA;AAAA,EACpB,+BAA+B,mCAAAC;AAAA,EAC/B,oBAAoB,wBAAAC;AAAA,EACpB,0BAA0B,8BAAAC;AAAA,EAC1B,qBAAqB,yBAAAC;AACtB;AAEO,MAAM,UAAU;AAAA,EACtB,aAAa;AAAA,IACZ,OAAO,OAAO;AAAA,MACb,OAAO,QAAQ,KAAK,EAClB,OAAO,CAAC,CAAC,EAAE,IAAI,MAAM,KAAK,KAAK,MAAM,WAAW,EAChD,IAAI,CAAC,CAAC,IAAI,MAAM,CAAC,kBAAkB,MAAM,OAAgB,CAAC;AAAA,IAC7D;AAAA,EACD;AACD;","names":["orderProperties","preferRepositoryShorthand","sortCollections","validLocalDependency","validPackageDef"]}

package/lib/index.mjs

@@ -1,9 +1,11 @@
 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";
 const rules = {
   "order-properties": orderProperties,
+  "prefer-repository-shorthand": preferRepositoryShorthand,
   "sort-collections": sortCollections,
   "valid-local-dependency": validLocalDependency,
   "valid-package-def": validPackageDef

package/lib/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import orderProperties from \"./rules/order-properties.js\";\nimport sortCollections from \"./rules/sort-collections.js\";\nimport validLocalDependency from \"./rules/valid-local-dependency.js\";\nimport validPackageDef from \"./rules/valid-package-def.js\";\n\nexport const rules = {\n\t\"order-properties\": orderProperties,\n\t\"sort-collections\": sortCollections,\n\t\"valid-local-dependency\": validLocalDependency,\n\t\"valid-package-def\": validPackageDef,\n};\n\nexport const configs = {\n\trecommended: {\n\t\trules: Object.fromEntries(\n\t\t\tObject.entries(rules)\n\t\t\t\t.filter(([, rule]) => rule.meta.docs?.recommended)\n\t\t\t\t.map(([name]) => [\"package-json/\" + name, \"error\" as const]),\n\t\t),\n\t},\n};\n"],"mappings":"AAAA,OAAO,qBAAqB;AAC5B,OAAO,qBAAqB;AAC5B,OAAO,0BAA0B;AACjC,OAAO,qBAAqB;AAErB,MAAM,QAAQ;AAAA,EACpB,oBAAoB;AAAA,EACpB,oBAAoB;AAAA,EACpB,0BAA0B;AAAA,EAC1B,qBAAqB;AACtB;AAEO,MAAM,UAAU;AAAA,EACtB,aAAa;AAAA,IACZ,OAAO,OAAO;AAAA,MACb,OAAO,QAAQ,KAAK,EAClB,OAAO,CAAC,CAAC,EAAE,IAAI,MAAM,KAAK,KAAK,MAAM,WAAW,EAChD,IAAI,CAAC,CAAC,IAAI,MAAM,CAAC,kBAAkB,MAAM,OAAgB,CAAC;AAAA,IAC7D;AAAA,EACD;AACD;","names":[]}
+{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import orderProperties from \"./rules/order-properties.js\";\nimport preferRepositoryShorthand from \"./rules/prefer-repository-shorthand.js\";\nimport sortCollections from \"./rules/sort-collections.js\";\nimport validLocalDependency from \"./rules/valid-local-dependency.js\";\nimport validPackageDef from \"./rules/valid-package-def.js\";\n\nexport const rules = {\n\t\"order-properties\": orderProperties,\n\t\"prefer-repository-shorthand\": preferRepositoryShorthand,\n\t\"sort-collections\": sortCollections,\n\t\"valid-local-dependency\": validLocalDependency,\n\t\"valid-package-def\": validPackageDef,\n};\n\nexport const configs = {\n\trecommended: {\n\t\trules: Object.fromEntries(\n\t\t\tObject.entries(rules)\n\t\t\t\t.filter(([, rule]) => rule.meta.docs?.recommended)\n\t\t\t\t.map(([name]) => [\"package-json/\" + name, \"error\" as const]),\n\t\t),\n\t},\n};\n"],"mappings":"AAAA,OAAO,qBAAqB;AAC5B,OAAO,+BAA+B;AACtC,OAAO,qBAAqB;AAC5B,OAAO,0BAA0B;AACjC,OAAO,qBAAqB;AAErB,MAAM,QAAQ;AAAA,EACpB,oBAAoB;AAAA,EACpB,+BAA+B;AAAA,EAC/B,oBAAoB;AAAA,EACpB,0BAA0B;AAAA,EAC1B,qBAAqB;AACtB;AAEO,MAAM,UAAU;AAAA,EACtB,aAAa;AAAA,IACZ,OAAO,OAAO;AAAA,MACb,OAAO,QAAQ,KAAK,EAClB,OAAO,CAAC,CAAC,EAAE,IAAI,MAAM,KAAK,KAAK,MAAM,WAAW,EAChD,IAAI,CAAC,CAAC,IAAI,MAAM,CAAC,kBAAkB,MAAM,OAAgB,CAAC;AAAA,IAC7D;AAAA,EACD;AACD;","names":[]}

package/lib/rules/prefer-repository-shorthand.d.mts

@@ -0,0 +1,11 @@
+import * as eslint from 'eslint';
+import * as jsonc_eslint_parser from 'jsonc-eslint-parser';
+import { PackageJsonRuleContext } from '../createRule.mjs';
+import 'estree';
+
+declare const _default: {
+    create(context: PackageJsonRuleContext<unknown[]>): jsonc_eslint_parser.RuleListener;
+    meta: eslint.Rule.RuleMetaData;
+};
+
+export { _default as default };

package/lib/rules/prefer-repository-shorthand.d.ts

@@ -0,0 +1,11 @@
+import * as eslint from 'eslint';
+import * as jsonc_eslint_parser from 'jsonc-eslint-parser';
+import { PackageJsonRuleContext } from '../createRule.js';
+import 'estree';
+
+declare const _default: {
+    create(context: PackageJsonRuleContext<unknown[]>): jsonc_eslint_parser.RuleListener;
+    meta: eslint.Rule.RuleMetaData;
+};
+
+export { _default as default };

package/lib/rules/prefer-repository-shorthand.js

@@ -0,0 +1,101 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var prefer_repository_shorthand_exports = {};
+__export(prefer_repository_shorthand_exports, {
+  default: () => prefer_repository_shorthand_default
+});
+module.exports = __toCommonJS(prefer_repository_shorthand_exports);
+var import_createRule = require("../createRule.js");
+const githubUrlRegex = /^(?:git\+)?(?:ssh:\/\/git@|http?s:\/\/)?(?:www\.)?github\.com\//;
+const isGitHubUrl = (url) => githubUrlRegex.test(url);
+const cleanGitHubUrl = (url) => url.replace(githubUrlRegex, "").replace(/\.git$/, "");
+function findJSONLiteralWithValue(properties, value) {
+  return properties.find(
+    (property) => property.key.type === "JSONLiteral" && property.key.value === value
+  );
+}
+var prefer_repository_shorthand_default = (0, import_createRule.createRule)({
+  create(context) {
+    return {
+      JSONProperty(node) {
+        if (node.key.type !== "JSONLiteral" || node.key.value !== "repository" || node.parent.parent.parent.type !== "Program") {
+          return;
+        }
+        if (node.value.type === "JSONObjectExpression") {
+          const { properties } = node.value;
+          if (findJSONLiteralWithValue(properties, "directory")) {
+            return;
+          }
+          const typeProperty = findJSONLiteralWithValue(
+            properties,
+            "type"
+          );
+          if (typeProperty?.value.type !== "JSONLiteral" || typeProperty.value.value !== "git") {
+            return;
+          }
+          const urlProperty = findJSONLiteralWithValue(
+            properties,
+            "url"
+          );
+          if (urlProperty?.value.type !== "JSONLiteral" || typeof urlProperty.value.value !== "string" || !isGitHubUrl(urlProperty.value.value)) {
+            return;
+          }
+          const url = urlProperty.value.value;
+          context.report({
+            fix(fixer) {
+              return fixer.replaceText(
+                node.value,
+                JSON.stringify(cleanGitHubUrl(url))
+              );
+            },
+            messageId: "preferShorthand",
+            node: node.value
+          });
+        }
+        if (node.value.type === "JSONLiteral") {
+          const { value } = node.value;
+          if (typeof value === "string" && isGitHubUrl(value)) {
+            context.report({
+              fix(fixer) {
+                return fixer.replaceText(
+                  node.value,
+                  JSON.stringify(cleanGitHubUrl(value))
+                );
+              },
+              messageId: "preferShorthand",
+              node: node.value
+            });
+          }
+        }
+      }
+    };
+  },
+  meta: {
+    docs: {
+      category: "Best Practices",
+      description: "Enforce shorthand declaration for GitHub repository.",
+      recommended: true
+    },
+    fixable: "code",
+    messages: {
+      preferShorthand: "Prefer a shorthand locator for a GitHub repository."
+    }
+  }
+});
+//# sourceMappingURL=prefer-repository-shorthand.js.map

package/lib/rules/prefer-repository-shorthand.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/rules/prefer-repository-shorthand.ts"],"sourcesContent":["import type ESTree from \"estree\";\nimport type { AST as JsonAST } from \"jsonc-eslint-parser\";\n\nimport { createRule } from \"../createRule.js\";\n\nconst githubUrlRegex =\n\t/^(?:git\\+)?(?:ssh:\\/\\/git@|http?s:\\/\\/)?(?:www\\.)?github\\.com\\//;\n\nconst isGitHubUrl = (url: string) => githubUrlRegex.test(url);\n\nconst cleanGitHubUrl = (url: string) =>\n\turl.replace(githubUrlRegex, \"\").replace(/\\.git$/, \"\");\n\ntype JSONPropertyWithKeyAndValue<Value extends string> =\n\tJsonAST.JSONProperty & {\n\t\tkey: JsonAST.JSONStringLiteral;\n\t\tvalue: Value;\n\t};\n\nfunction findJSONLiteralWithValue<Value extends string>(\n\tproperties: JsonAST.JSONProperty[],\n\tvalue: Value,\n) {\n\treturn properties.find(\n\t\t(property): property is JSONPropertyWithKeyAndValue<Value> =>\n\t\t\tproperty.key.type === \"JSONLiteral\" && property.key.value === value,\n\t);\n}\n\nexport default createRule({\n\tcreate(context) {\n\t\treturn {\n\t\t\tJSONProperty(node) {\n\t\t\t\tif (\n\t\t\t\t\tnode.key.type !== \"JSONLiteral\" ||\n\t\t\t\t\tnode.key.value !== \"repository\" ||\n\t\t\t\t\tnode.parent.parent.parent.type !== \"Program\"\n\t\t\t\t) {\n\t\t\t\t\treturn;\n\t\t\t\t}\n\n\t\t\t\tif (node.value.type === \"JSONObjectExpression\") {\n\t\t\t\t\tconst { properties } = node.value;\n\n\t\t\t\t\tif (findJSONLiteralWithValue(properties, \"directory\")) {\n\t\t\t\t\t\treturn;\n\t\t\t\t\t}\n\n\t\t\t\t\tconst typeProperty = findJSONLiteralWithValue(\n\t\t\t\t\t\tproperties,\n\t\t\t\t\t\t\"type\",\n\t\t\t\t\t);\n\t\t\t\t\tif (\n\t\t\t\t\t\ttypeProperty?.value.type !== \"JSONLiteral\" ||\n\t\t\t\t\t\ttypeProperty.value.value !== \"git\"\n\t\t\t\t\t) {\n\t\t\t\t\t\treturn;\n\t\t\t\t\t}\n\n\t\t\t\t\tconst urlProperty = findJSONLiteralWithValue(\n\t\t\t\t\t\tproperties,\n\t\t\t\t\t\t\"url\",\n\t\t\t\t\t);\n\t\t\t\t\tif (\n\t\t\t\t\t\turlProperty?.value.type !== \"JSONLiteral\" ||\n\t\t\t\t\t\ttypeof urlProperty.value.value !== \"string\" ||\n\t\t\t\t\t\t!isGitHubUrl(urlProperty.value.value)\n\t\t\t\t\t) {\n\t\t\t\t\t\treturn;\n\t\t\t\t\t}\n\n\t\t\t\t\tconst url = urlProperty.value.value;\n\n\t\t\t\t\tcontext.report({\n\t\t\t\t\t\tfix(fixer) {\n\t\t\t\t\t\t\treturn fixer.replaceText(\n\t\t\t\t\t\t\t\tnode.value as unknown as ESTree.Node,\n\t\t\t\t\t\t\t\tJSON.stringify(cleanGitHubUrl(url)),\n\t\t\t\t\t\t\t);\n\t\t\t\t\t\t},\n\t\t\t\t\t\tmessageId: \"preferShorthand\",\n\t\t\t\t\t\tnode: node.value as unknown as ESTree.Node,\n\t\t\t\t\t});\n\t\t\t\t}\n\n\t\t\t\tif (node.value.type === \"JSONLiteral\") {\n\t\t\t\t\tconst { value } = node.value;\n\t\t\t\t\tif (typeof value === \"string\" && isGitHubUrl(value)) {\n\t\t\t\t\t\tcontext.report({\n\t\t\t\t\t\t\tfix(fixer) {\n\t\t\t\t\t\t\t\treturn fixer.replaceText(\n\t\t\t\t\t\t\t\t\tnode.value as unknown as ESTree.Node,\n\t\t\t\t\t\t\t\t\tJSON.stringify(cleanGitHubUrl(value)),\n\t\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tmessageId: \"preferShorthand\",\n\t\t\t\t\t\t\tnode: node.value as unknown as ESTree.Node,\n\t\t\t\t\t\t});\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t};\n\t},\n\n\tmeta: {\n\t\tdocs: {\n\t\t\tcategory: \"Best Practices\",\n\t\t\tdescription: \"Enforce shorthand declaration for GitHub repository.\",\n\t\t\trecommended: true,\n\t\t},\n\t\tfixable: \"code\",\n\t\tmessages: {\n\t\t\tpreferShorthand:\n\t\t\t\t\"Prefer a shorthand locator for a GitHub repository.\",\n\t\t},\n\t},\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAGA,wBAA2B;AAE3B,MAAM,iBACL;AAED,MAAM,cAAc,CAAC,QAAgB,eAAe,KAAK,GAAG;AAE5D,MAAM,iBAAiB,CAAC,QACvB,IAAI,QAAQ,gBAAgB,EAAE,EAAE,QAAQ,UAAU,EAAE;AAQrD,SAAS,yBACR,YACA,OACC;AACD,SAAO,WAAW;AAAA,IACjB,CAAC,aACA,SAAS,IAAI,SAAS,iBAAiB,SAAS,IAAI,UAAU;AAAA,EAChE;AACD;AAEA,IAAO,0CAAQ,8BAAW;AAAA,EACzB,OAAO,SAAS;AACf,WAAO;AAAA,MACN,aAAa,MAAM;AAClB,YACC,KAAK,IAAI,SAAS,iBAClB,KAAK,IAAI,UAAU,gBACnB,KAAK,OAAO,OAAO,OAAO,SAAS,WAClC;AACD;AAAA,QACD;AAEA,YAAI,KAAK,MAAM,SAAS,wBAAwB;AAC/C,gBAAM,EAAE,WAAW,IAAI,KAAK;AAE5B,cAAI,yBAAyB,YAAY,WAAW,GAAG;AACtD;AAAA,UACD;AAEA,gBAAM,eAAe;AAAA,YACpB;AAAA,YACA;AAAA,UACD;AACA,cACC,cAAc,MAAM,SAAS,iBAC7B,aAAa,MAAM,UAAU,OAC5B;AACD;AAAA,UACD;AAEA,gBAAM,cAAc;AAAA,YACnB;AAAA,YACA;AAAA,UACD;AACA,cACC,aAAa,MAAM,SAAS,iBAC5B,OAAO,YAAY,MAAM,UAAU,YACnC,CAAC,YAAY,YAAY,MAAM,KAAK,GACnC;AACD;AAAA,UACD;AAEA,gBAAM,MAAM,YAAY,MAAM;AAE9B,kBAAQ,OAAO;AAAA,YACd,IAAI,OAAO;AACV,qBAAO,MAAM;AAAA,gBACZ,KAAK;AAAA,gBACL,KAAK,UAAU,eAAe,GAAG,CAAC;AAAA,cACnC;AAAA,YACD;AAAA,YACA,WAAW;AAAA,YACX,MAAM,KAAK;AAAA,UACZ,CAAC;AAAA,QACF;AAEA,YAAI,KAAK,MAAM,SAAS,eAAe;AACtC,gBAAM,EAAE,MAAM,IAAI,KAAK;AACvB,cAAI,OAAO,UAAU,YAAY,YAAY,KAAK,GAAG;AACpD,oBAAQ,OAAO;AAAA,cACd,IAAI,OAAO;AACV,uBAAO,MAAM;AAAA,kBACZ,KAAK;AAAA,kBACL,KAAK,UAAU,eAAe,KAAK,CAAC;AAAA,gBACrC;AAAA,cACD;AAAA,cACA,WAAW;AAAA,cACX,MAAM,KAAK;AAAA,YACZ,CAAC;AAAA,UACF;AAAA,QACD;AAAA,MACD;AAAA,IACD;AAAA,EACD;AAAA,EAEA,MAAM;AAAA,IACL,MAAM;AAAA,MACL,UAAU;AAAA,MACV,aAAa;AAAA,MACb,aAAa;AAAA,IACd;AAAA,IACA,SAAS;AAAA,IACT,UAAU;AAAA,MACT,iBACC;AAAA,IACF;AAAA,EACD;AACD,CAAC;","names":[]}

package/lib/rules/prefer-repository-shorthand.mjs

@@ -0,0 +1,81 @@
+import { createRule } from "../createRule.js";
+const githubUrlRegex = /^(?:git\+)?(?:ssh:\/\/git@|http?s:\/\/)?(?:www\.)?github\.com\//;
+const isGitHubUrl = (url) => githubUrlRegex.test(url);
+const cleanGitHubUrl = (url) => url.replace(githubUrlRegex, "").replace(/\.git$/, "");
+function findJSONLiteralWithValue(properties, value) {
+  return properties.find(
+    (property) => property.key.type === "JSONLiteral" && property.key.value === value
+  );
+}
+var prefer_repository_shorthand_default = createRule({
+  create(context) {
+    return {
+      JSONProperty(node) {
+        if (node.key.type !== "JSONLiteral" || node.key.value !== "repository" || node.parent.parent.parent.type !== "Program") {
+          return;
+        }
+        if (node.value.type === "JSONObjectExpression") {
+          const { properties } = node.value;
+          if (findJSONLiteralWithValue(properties, "directory")) {
+            return;
+          }
+          const typeProperty = findJSONLiteralWithValue(
+            properties,
+            "type"
+          );
+          if (typeProperty?.value.type !== "JSONLiteral" || typeProperty.value.value !== "git") {
+            return;
+          }
+          const urlProperty = findJSONLiteralWithValue(
+            properties,
+            "url"
+          );
+          if (urlProperty?.value.type !== "JSONLiteral" || typeof urlProperty.value.value !== "string" || !isGitHubUrl(urlProperty.value.value)) {
+            return;
+          }
+          const url = urlProperty.value.value;
+          context.report({
+            fix(fixer) {
+              return fixer.replaceText(
+                node.value,
+                JSON.stringify(cleanGitHubUrl(url))
+              );
+            },
+            messageId: "preferShorthand",
+            node: node.value
+          });
+        }
+        if (node.value.type === "JSONLiteral") {
+          const { value } = node.value;
+          if (typeof value === "string" && isGitHubUrl(value)) {
+            context.report({
+              fix(fixer) {
+                return fixer.replaceText(
+                  node.value,
+                  JSON.stringify(cleanGitHubUrl(value))
+                );
+              },
+              messageId: "preferShorthand",
+              node: node.value
+            });
+          }
+        }
+      }
+    };
+  },
+  meta: {
+    docs: {
+      category: "Best Practices",
+      description: "Enforce shorthand declaration for GitHub repository.",
+      recommended: true
+    },
+    fixable: "code",
+    messages: {
+      preferShorthand: "Prefer a shorthand locator for a GitHub repository."
+    }
+  }
+});
+export {
+  prefer_repository_shorthand_default as default
+};
+//# sourceMappingURL=prefer-repository-shorthand.mjs.map

package/lib/rules/prefer-repository-shorthand.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/rules/prefer-repository-shorthand.ts"],"sourcesContent":["import type ESTree from \"estree\";\nimport type { AST as JsonAST } from \"jsonc-eslint-parser\";\n\nimport { createRule } from \"../createRule.js\";\n\nconst githubUrlRegex =\n\t/^(?:git\\+)?(?:ssh:\\/\\/git@|http?s:\\/\\/)?(?:www\\.)?github\\.com\\//;\n\nconst isGitHubUrl = (url: string) => githubUrlRegex.test(url);\n\nconst cleanGitHubUrl = (url: string) =>\n\turl.replace(githubUrlRegex, \"\").replace(/\\.git$/, \"\");\n\ntype JSONPropertyWithKeyAndValue<Value extends string> =\n\tJsonAST.JSONProperty & {\n\t\tkey: JsonAST.JSONStringLiteral;\n\t\tvalue: Value;\n\t};\n\nfunction findJSONLiteralWithValue<Value extends string>(\n\tproperties: JsonAST.JSONProperty[],\n\tvalue: Value,\n) {\n\treturn properties.find(\n\t\t(property): property is JSONPropertyWithKeyAndValue<Value> =>\n\t\t\tproperty.key.type === \"JSONLiteral\" && property.key.value === value,\n\t);\n}\n\nexport default createRule({\n\tcreate(context) {\n\t\treturn {\n\t\t\tJSONProperty(node) {\n\t\t\t\tif (\n\t\t\t\t\tnode.key.type !== \"JSONLiteral\" ||\n\t\t\t\t\tnode.key.value !== \"repository\" ||\n\t\t\t\t\tnode.parent.parent.parent.type !== \"Program\"\n\t\t\t\t) {\n\t\t\t\t\treturn;\n\t\t\t\t}\n\n\t\t\t\tif (node.value.type === \"JSONObjectExpression\") {\n\t\t\t\t\tconst { properties } = node.value;\n\n\t\t\t\t\tif (findJSONLiteralWithValue(properties, \"directory\")) {\n\t\t\t\t\t\treturn;\n\t\t\t\t\t}\n\n\t\t\t\t\tconst typeProperty = findJSONLiteralWithValue(\n\t\t\t\t\t\tproperties,\n\t\t\t\t\t\t\"type\",\n\t\t\t\t\t);\n\t\t\t\t\tif (\n\t\t\t\t\t\ttypeProperty?.value.type !== \"JSONLiteral\" ||\n\t\t\t\t\t\ttypeProperty.value.value !== \"git\"\n\t\t\t\t\t) {\n\t\t\t\t\t\treturn;\n\t\t\t\t\t}\n\n\t\t\t\t\tconst urlProperty = findJSONLiteralWithValue(\n\t\t\t\t\t\tproperties,\n\t\t\t\t\t\t\"url\",\n\t\t\t\t\t);\n\t\t\t\t\tif (\n\t\t\t\t\t\turlProperty?.value.type !== \"JSONLiteral\" ||\n\t\t\t\t\t\ttypeof urlProperty.value.value !== \"string\" ||\n\t\t\t\t\t\t!isGitHubUrl(urlProperty.value.value)\n\t\t\t\t\t) {\n\t\t\t\t\t\treturn;\n\t\t\t\t\t}\n\n\t\t\t\t\tconst url = urlProperty.value.value;\n\n\t\t\t\t\tcontext.report({\n\t\t\t\t\t\tfix(fixer) {\n\t\t\t\t\t\t\treturn fixer.replaceText(\n\t\t\t\t\t\t\t\tnode.value as unknown as ESTree.Node,\n\t\t\t\t\t\t\t\tJSON.stringify(cleanGitHubUrl(url)),\n\t\t\t\t\t\t\t);\n\t\t\t\t\t\t},\n\t\t\t\t\t\tmessageId: \"preferShorthand\",\n\t\t\t\t\t\tnode: node.value as unknown as ESTree.Node,\n\t\t\t\t\t});\n\t\t\t\t}\n\n\t\t\t\tif (node.value.type === \"JSONLiteral\") {\n\t\t\t\t\tconst { value } = node.value;\n\t\t\t\t\tif (typeof value === \"string\" && isGitHubUrl(value)) {\n\t\t\t\t\t\tcontext.report({\n\t\t\t\t\t\t\tfix(fixer) {\n\t\t\t\t\t\t\t\treturn fixer.replaceText(\n\t\t\t\t\t\t\t\t\tnode.value as unknown as ESTree.Node,\n\t\t\t\t\t\t\t\t\tJSON.stringify(cleanGitHubUrl(value)),\n\t\t\t\t\t\t\t\t);\n\t\t\t\t\t\t\t},\n\t\t\t\t\t\t\tmessageId: \"preferShorthand\",\n\t\t\t\t\t\t\tnode: node.value as unknown as ESTree.Node,\n\t\t\t\t\t\t});\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t},\n\t\t};\n\t},\n\n\tmeta: {\n\t\tdocs: {\n\t\t\tcategory: \"Best Practices\",\n\t\t\tdescription: \"Enforce shorthand declaration for GitHub repository.\",\n\t\t\trecommended: true,\n\t\t},\n\t\tfixable: \"code\",\n\t\tmessages: {\n\t\t\tpreferShorthand:\n\t\t\t\t\"Prefer a shorthand locator for a GitHub repository.\",\n\t\t},\n\t},\n});\n"],"mappings":"AAGA,SAAS,kBAAkB;AAE3B,MAAM,iBACL;AAED,MAAM,cAAc,CAAC,QAAgB,eAAe,KAAK,GAAG;AAE5D,MAAM,iBAAiB,CAAC,QACvB,IAAI,QAAQ,gBAAgB,EAAE,EAAE,QAAQ,UAAU,EAAE;AAQrD,SAAS,yBACR,YACA,OACC;AACD,SAAO,WAAW;AAAA,IACjB,CAAC,aACA,SAAS,IAAI,SAAS,iBAAiB,SAAS,IAAI,UAAU;AAAA,EAChE;AACD;AAEA,IAAO,sCAAQ,WAAW;AAAA,EACzB,OAAO,SAAS;AACf,WAAO;AAAA,MACN,aAAa,MAAM;AAClB,YACC,KAAK,IAAI,SAAS,iBAClB,KAAK,IAAI,UAAU,gBACnB,KAAK,OAAO,OAAO,OAAO,SAAS,WAClC;AACD;AAAA,QACD;AAEA,YAAI,KAAK,MAAM,SAAS,wBAAwB;AAC/C,gBAAM,EAAE,WAAW,IAAI,KAAK;AAE5B,cAAI,yBAAyB,YAAY,WAAW,GAAG;AACtD;AAAA,UACD;AAEA,gBAAM,eAAe;AAAA,YACpB;AAAA,YACA;AAAA,UACD;AACA,cACC,cAAc,MAAM,SAAS,iBAC7B,aAAa,MAAM,UAAU,OAC5B;AACD;AAAA,UACD;AAEA,gBAAM,cAAc;AAAA,YACnB;AAAA,YACA;AAAA,UACD;AACA,cACC,aAAa,MAAM,SAAS,iBAC5B,OAAO,YAAY,MAAM,UAAU,YACnC,CAAC,YAAY,YAAY,MAAM,KAAK,GACnC;AACD;AAAA,UACD;AAEA,gBAAM,MAAM,YAAY,MAAM;AAE9B,kBAAQ,OAAO;AAAA,YACd,IAAI,OAAO;AACV,qBAAO,MAAM;AAAA,gBACZ,KAAK;AAAA,gBACL,KAAK,UAAU,eAAe,GAAG,CAAC;AAAA,cACnC;AAAA,YACD;AAAA,YACA,WAAW;AAAA,YACX,MAAM,KAAK;AAAA,UACZ,CAAC;AAAA,QACF;AAEA,YAAI,KAAK,MAAM,SAAS,eAAe;AACtC,gBAAM,EAAE,MAAM,IAAI,KAAK;AACvB,cAAI,OAAO,UAAU,YAAY,YAAY,KAAK,GAAG;AACpD,oBAAQ,OAAO;AAAA,cACd,IAAI,OAAO;AACV,uBAAO,MAAM;AAAA,kBACZ,KAAK;AAAA,kBACL,KAAK,UAAU,eAAe,KAAK,CAAC;AAAA,gBACrC;AAAA,cACD;AAAA,cACA,WAAW;AAAA,cACX,MAAM,KAAK;AAAA,YACZ,CAAC;AAAA,UACF;AAAA,QACD;AAAA,MACD;AAAA,IACD;AAAA,EACD;AAAA,EAEA,MAAM;AAAA,IACL,MAAM;AAAA,MACL,UAAU;AAAA,MACV,aAAa;AAAA,MACb,aAAa;AAAA,IACd;AAAA,IACA,SAAS;AAAA,IACT,UAAU;AAAA,MACT,iBACC;AAAA,IACF;AAAA,EACD;AACD,CAAC;","names":[]}

package/package.json

@@ -1,15 +1,12 @@
 {
 	"name": "eslint-plugin-package-json",
-	"version": "0.4.0",
+	"version": "0.5.0",
 	"description": "Rules for consistent, readable, and valid package.json files. 🗂️",
-	"homepage": "https://github.com/zetlen/eslint-plugin-package-json#readme",
+	"homepage": "https://github.com/JoshuaKGoldberg/eslint-plugin-package-json#readme",
 	"bugs": {
-		"url": "https://github.com/zetlen/eslint-plugin-package-json/issues"
-	},
-	"repository": {
-		"type": "git",
-		"url": "https://github.com/JoshuaKGoldberg/eslint-plugin-package-json"
+		"url": "https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues"
 	},
+	"repository": "JoshuaKGoldberg/eslint-plugin-package-json",
 	"license": "MIT",
 	"author": {
 		"name": "James Zetlan",