eslint-plugin-package-json 0.3.2 → 0.5.0

package/README.md

@@ -1,17 +1,35 @@
-# eslint-plugin-package-json
-
-Rules for valid, consistent, and readable package.json files
-
-> ⚠️ This README.md is for the `0.3.x` versions of this package.
-> Those versions are tagged as `beta` on npm.
-> For 0.2.x, see [the latest 0.2.x README.md](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/tree/a1c3bf76fb1a55e85f071051be55dc06ebb47c8b).
+<h1 align="center">eslint-plugin-package-json</h1>
+
+<p align="center">Rules for consistent, readable, and valid package.json files. 🗂️</p>
+
+<p align="center">
+	<a href="#contributors" target="_blank">
+<!-- prettier-ignore-start -->
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+<img alt="All Contributors: 13 👪" src="https://img.shields.io/badge/all_contributors-13_👪-21bb42.svg" />
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+<!-- prettier-ignore-end -->
+</a>
+	<a href="https://codecov.io/gh/JoshuaKGoldberg/eslint-plugin-package-json" target="_blank">
+		<img alt="Codecov Test Coverage" src="https://codecov.io/gh/JoshuaKGoldberg/eslint-plugin-package-json/branch/main/graph/badge.svg"/>
+	</a>
+	<a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/blob/main/.github/CODE_OF_CONDUCT.md" target="_blank">
+		<img alt="Contributor Covenant" src="https://img.shields.io/badge/code_of_conduct-enforced-21bb42" />
+	</a>
+	<a href="https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/blob/main/LICENSE.md" target="_blank">
+		<img alt="License: MIT" src="https://img.shields.io/github/license/JoshuaKGoldberg/eslint-plugin-package-json?color=21bb42">
+	</a>
+	<img alt="Style: Prettier" src="https://img.shields.io/badge/style-prettier-21bb42.svg" />
+	<img alt="TypeScript: Strict" src="https://img.shields.io/badge/typescript-strict-21bb42.svg" />
+	<img alt="npm package version" src="https://img.shields.io/npm/v/eslint-plugin-package-json?color=21bb42" />
+</p>
 
 ## Installation
 
 You'll first need to install [ESLint](http://eslint.org) >=8 and `eslint-plugin-package-json`:
 
 ```shell
-$ npm install eslint eslint-plugin-package-json jsonc-eslint-parser --save-dev
+npm install eslint eslint-plugin-package-json jsonc-eslint-parser --save-dev
 ```
 
 **Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-package-json` globally.
@@ -22,14 +40,14 @@ Add an override to your ESLint configuration file that specifies this plugin, [`
 
 ```js
 module.exports = {
-    overrides: [
-        {
-            extends: ['plugin:package-json/recommended'],
-            files: ['package.json'],
-            parser: 'jsonc-eslint-parser',
-            plugins: ['package-json']
-        }
-    ]
+	overrides: [
+		{
+			extends: ["plugin:package-json/recommended"],
+			files: ["package.json"],
+			parser: "jsonc-eslint-parser",
+			plugins: ["package-json"],
+		},
+	],
 };
 ```
 
@@ -37,36 +55,77 @@ Or, individually configure the rules you want to use under the rules section.
 
 ```js
 module.exports = {
-    overrides: [
-        {
-            files: ['package.json'],
-            parser: 'jsonc-eslint-parser',
-            plugins: ['package-json'],
-            rules: {
-                'package-json/valid-package-def': 'error'
-            }
-        }
-    ]
+	overrides: [
+		{
+			files: ["package.json"],
+			parser: "jsonc-eslint-parser",
+			plugins: ["package-json"],
+			rules: {
+				"package-json/valid-package-def": "error",
+			},
+		},
+	],
 };
 ```
 
 ## Supported Rules
 
+<!-- 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 -->
 
 These rules only run on `package.json` files; they will ignore all other files being linted. They lint `package.json` files at project root, and in any subfolder of the project, making this plugin great for monorepos.
 
+## Contributors
+
+<!-- spellchecker: disable -->
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<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> <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>
+      <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>
+</table>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+<!-- spellchecker: enable -->
+
 ## Appreciation
 
 Many thanks to [@zetlen](https://github.com/zetlen) for creating the initial version and core infrastructure of this package! 💖
+
+> 💙 This package was templated with [create-typescript-app](https://github.com/JoshuaKGoldberg/create-typescript-app).

package/lib/createRule.d.mts

@@ -0,0 +1,33 @@
+import * as ESTree from 'estree';
+import { AST as AST$1, SourceCode, Rule } from 'eslint';
+import { AST, RuleListener } from 'jsonc-eslint-parser';
+
+type JsonAstBodyProperty = AST.JSONProperty & {
+    value: string;
+};
+type JsonAstBodyExpression = ESTree.Expression & {
+    properties: JsonAstBodyProperty[];
+};
+interface JsonAstBodyStatement extends ESTree.ExpressionStatement {
+    expression: JsonAstBodyExpression;
+}
+interface PackageJsonAst extends AST$1.Program {
+    body: [JsonAstBodyStatement];
+}
+interface PackageJsonSourceCode extends SourceCode {
+    ast: PackageJsonAst;
+}
+interface PackageJsonRuleContext<Options extends unknown[] = unknown[]> extends Rule.RuleContext {
+    options: Options;
+    sourceCode: PackageJsonSourceCode;
+}
+interface PackageJsonRuleModule<Options extends unknown[] = unknown[]> {
+    create(context: PackageJsonRuleContext<Options>): RuleListener;
+    meta: Rule.RuleMetaData;
+}
+declare function createRule<Options extends unknown[]>(rule: PackageJsonRuleModule<Options>): {
+    create(context: PackageJsonRuleContext<Options>): RuleListener;
+    meta: Rule.RuleMetaData;
+};
+
+export { type JsonAstBodyExpression, type JsonAstBodyProperty, type JsonAstBodyStatement, type PackageJsonAst, type PackageJsonRuleContext, type PackageJsonRuleModule, type PackageJsonSourceCode, createRule };

package/lib/createRule.d.ts

@@ -1,30 +1,33 @@
-import { AST, Rule, SourceCode } from 'eslint';
-import { AST as JsonAST, RuleListener } from "jsonc-eslint-parser";
-import type * as ESTree from 'estree';
-export type JsonAstBodyProperty = (JsonAST.JSONProperty & {
+import * as ESTree from 'estree';
+import { AST as AST$1, SourceCode, Rule } from 'eslint';
+import { AST, RuleListener } from 'jsonc-eslint-parser';
+
+type JsonAstBodyProperty = AST.JSONProperty & {
     value: string;
-});
-export type JsonAstBodyExpression = ESTree.Expression & {
+};
+type JsonAstBodyExpression = ESTree.Expression & {
     properties: JsonAstBodyProperty[];
 };
-export interface JsonAstBodyStatement extends ESTree.ExpressionStatement {
+interface JsonAstBodyStatement extends ESTree.ExpressionStatement {
     expression: JsonAstBodyExpression;
 }
-export interface PackageJsonAst extends AST.Program {
+interface PackageJsonAst extends AST$1.Program {
     body: [JsonAstBodyStatement];
 }
-export interface PackageJsonSourceCode extends SourceCode {
+interface PackageJsonSourceCode extends SourceCode {
     ast: PackageJsonAst;
 }
-export interface PackageJsonRuleContext extends Rule.RuleContext {
+interface PackageJsonRuleContext<Options extends unknown[] = unknown[]> extends Rule.RuleContext {
+    options: Options;
     sourceCode: PackageJsonSourceCode;
 }
-export interface PackageJsonRuleModule {
+interface PackageJsonRuleModule<Options extends unknown[] = unknown[]> {
+    create(context: PackageJsonRuleContext<Options>): RuleListener;
     meta: Rule.RuleMetaData;
-    create(context: PackageJsonRuleContext): RuleListener;
 }
-export declare function createRule(rule: PackageJsonRuleModule): {
-    create(context: PackageJsonRuleContext): RuleListener;
+declare function createRule<Options extends unknown[]>(rule: PackageJsonRuleModule<Options>): {
+    create(context: PackageJsonRuleContext<Options>): RuleListener;
     meta: Rule.RuleMetaData;
 };
-//# sourceMappingURL=createRule.d.ts.map
+
+export { type JsonAstBodyExpression, type JsonAstBodyProperty, type JsonAstBodyStatement, type PackageJsonAst, type PackageJsonRuleContext, type PackageJsonRuleModule, type PackageJsonSourceCode, createRule };

package/lib/createRule.js

@@ -1,16 +1,40 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createRule = void 0;
-const isPackageJson = (filePath) => filePath.endsWith('/package.json') || filePath === 'package.json';
+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 createRule_exports = {};
+__export(createRule_exports, {
+  createRule: () => createRule
+});
+module.exports = __toCommonJS(createRule_exports);
+const isPackageJson = (filePath) => filePath.endsWith("/package.json") || filePath === "package.json";
 function createRule(rule) {
-    return {
-        ...rule,
-        create(context) {
-            if (!isPackageJson(context.filename)) {
-                return {};
-            }
-            return rule.create(context);
-        }
-    };
+  return {
+    ...rule,
+    create(context) {
+      if (!isPackageJson(context.filename)) {
+        return {};
+      }
+      return rule.create(context);
+    }
+  };
 }
-exports.createRule = createRule;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createRule
+});
+//# sourceMappingURL=createRule.js.map

package/lib/createRule.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/createRule.ts"],"sourcesContent":["import type * as ESTree from \"estree\";\n\nimport { AST, Rule, SourceCode } from \"eslint\";\nimport { AST as JsonAST, RuleListener } from \"jsonc-eslint-parser\";\n\nconst isPackageJson = (filePath: string) =>\n\tfilePath.endsWith(\"/package.json\") || filePath === \"package.json\";\n\nexport type JsonAstBodyProperty = JsonAST.JSONProperty & {\n\tvalue: string;\n};\n\nexport type JsonAstBodyExpression = ESTree.Expression & {\n\tproperties: JsonAstBodyProperty[];\n};\n\nexport interface JsonAstBodyStatement extends ESTree.ExpressionStatement {\n\texpression: JsonAstBodyExpression;\n}\n\nexport interface PackageJsonAst extends AST.Program {\n\tbody: [JsonAstBodyStatement];\n}\n\nexport interface PackageJsonSourceCode extends SourceCode {\n\tast: PackageJsonAst;\n}\n\nexport interface PackageJsonRuleContext<Options extends unknown[] = unknown[]>\n\textends Rule.RuleContext {\n\toptions: Options;\n\tsourceCode: PackageJsonSourceCode;\n}\n\nexport interface PackageJsonRuleModule<Options extends unknown[] = unknown[]> {\n\tcreate(context: PackageJsonRuleContext<Options>): RuleListener;\n\tmeta: Rule.RuleMetaData;\n}\n\nexport function createRule<Options extends unknown[]>(\n\trule: PackageJsonRuleModule<Options>,\n) {\n\treturn {\n\t\t...rule,\n\t\tcreate(context: PackageJsonRuleContext<Options>) {\n\t\t\tif (!isPackageJson(context.filename)) {\n\t\t\t\treturn {};\n\t\t\t}\n\n\t\t\treturn rule.create(context);\n\t\t},\n\t};\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAKA,MAAM,gBAAgB,CAAC,aACtB,SAAS,SAAS,eAAe,KAAK,aAAa;AAiC7C,SAAS,WACf,MACC;AACD,SAAO;AAAA,IACN,GAAG;AAAA,IACH,OAAO,SAA0C;AAChD,UAAI,CAAC,cAAc,QAAQ,QAAQ,GAAG;AACrC,eAAO,CAAC;AAAA,MACT;AAEA,aAAO,KAAK,OAAO,OAAO;AAAA,IAC3B;AAAA,EACD;AACD;","names":[]}

package/lib/createRule.mjs

@@ -0,0 +1,16 @@
+const isPackageJson = (filePath) => filePath.endsWith("/package.json") || filePath === "package.json";
+function createRule(rule) {
+  return {
+    ...rule,
+    create(context) {
+      if (!isPackageJson(context.filename)) {
+        return {};
+      }
+      return rule.create(context);
+    }
+  };
+}
+export {
+  createRule
+};
+//# sourceMappingURL=createRule.mjs.map

package/lib/createRule.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/createRule.ts"],"sourcesContent":["import type * as ESTree from \"estree\";\n\nimport { AST, Rule, SourceCode } from \"eslint\";\nimport { AST as JsonAST, RuleListener } from \"jsonc-eslint-parser\";\n\nconst isPackageJson = (filePath: string) =>\n\tfilePath.endsWith(\"/package.json\") || filePath === \"package.json\";\n\nexport type JsonAstBodyProperty = JsonAST.JSONProperty & {\n\tvalue: string;\n};\n\nexport type JsonAstBodyExpression = ESTree.Expression & {\n\tproperties: JsonAstBodyProperty[];\n};\n\nexport interface JsonAstBodyStatement extends ESTree.ExpressionStatement {\n\texpression: JsonAstBodyExpression;\n}\n\nexport interface PackageJsonAst extends AST.Program {\n\tbody: [JsonAstBodyStatement];\n}\n\nexport interface PackageJsonSourceCode extends SourceCode {\n\tast: PackageJsonAst;\n}\n\nexport interface PackageJsonRuleContext<Options extends unknown[] = unknown[]>\n\textends Rule.RuleContext {\n\toptions: Options;\n\tsourceCode: PackageJsonSourceCode;\n}\n\nexport interface PackageJsonRuleModule<Options extends unknown[] = unknown[]> {\n\tcreate(context: PackageJsonRuleContext<Options>): RuleListener;\n\tmeta: Rule.RuleMetaData;\n}\n\nexport function createRule<Options extends unknown[]>(\n\trule: PackageJsonRuleModule<Options>,\n) {\n\treturn {\n\t\t...rule,\n\t\tcreate(context: PackageJsonRuleContext<Options>) {\n\t\t\tif (!isPackageJson(context.filename)) {\n\t\t\t\treturn {};\n\t\t\t}\n\n\t\t\treturn rule.create(context);\n\t\t},\n\t};\n}\n"],"mappings":"AAKA,MAAM,gBAAgB,CAAC,aACtB,SAAS,SAAS,eAAe,KAAK,aAAa;AAiC7C,SAAS,WACf,MACC;AACD,SAAO;AAAA,IACN,GAAG;AAAA,IACH,OAAO,SAA0C;AAChD,UAAI,CAAC,cAAc,QAAQ,QAAQ,GAAG;AACrC,eAAO,CAAC;AAAA,MACT;AAEA,aAAO,KAAK,OAAO,OAAO;AAAA,IAC3B;AAAA,EACD;AACD;","names":[]}

package/lib/index.d.mts

@@ -0,0 +1,38 @@
+import * as eslint from 'eslint';
+import * as jsonc_eslint_parser from 'jsonc-eslint-parser';
+import { PackageJsonRuleContext } from './createRule.mjs';
+import 'estree';
+
+declare const rules: {
+    "order-properties": {
+        create(context: PackageJsonRuleContext<[({
+            order: "legacy" | "sort-package-json";
+        } | 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;
+    };
+    "valid-local-dependency": {
+        create(context: PackageJsonRuleContext<unknown[]>): jsonc_eslint_parser.RuleListener;
+        meta: eslint.Rule.RuleMetaData;
+    };
+    "valid-package-def": {
+        create(context: PackageJsonRuleContext<unknown[]>): jsonc_eslint_parser.RuleListener;
+        meta: eslint.Rule.RuleMetaData;
+    };
+};
+declare const configs: {
+    recommended: {
+        rules: {
+            [k: string]: "error";
+        };
+    };
+};
+
+export { configs, rules };

package/lib/index.d.ts

@@ -1,41 +1,38 @@
-export declare const rules: {
-    'order-properties': {
-        create(context: import("./createRule").PackageJsonRuleContext): import("jsonc-eslint-parser").RuleListener;
-        meta: import("eslint").Rule.RuleMetaData;
+import * as eslint from 'eslint';
+import * as jsonc_eslint_parser from 'jsonc-eslint-parser';
+import { PackageJsonRuleContext } from './createRule.js';
+import 'estree';
+
+declare const rules: {
+    "order-properties": {
+        create(context: PackageJsonRuleContext<[({
+            order: "legacy" | "sort-package-json";
+        } | undefined)?]>): jsonc_eslint_parser.RuleListener;
+        meta: eslint.Rule.RuleMetaData;
     };
-    'sort-collections': {
-        create(context: import("./createRule").PackageJsonRuleContext): import("jsonc-eslint-parser").RuleListener;
-        meta: import("eslint").Rule.RuleMetaData;
+    "prefer-repository-shorthand": {
+        create(context: PackageJsonRuleContext<unknown[]>): jsonc_eslint_parser.RuleListener;
+        meta: eslint.Rule.RuleMetaData;
     };
-    'valid-local-dependency': {
-        create(context: import("./createRule").PackageJsonRuleContext): import("jsonc-eslint-parser").RuleListener;
-        meta: import("eslint").Rule.RuleMetaData;
+    "sort-collections": {
+        create(context: PackageJsonRuleContext<string[]>): jsonc_eslint_parser.RuleListener;
+        meta: eslint.Rule.RuleMetaData;
     };
-    'valid-package-def': {
-        create(context: import("./createRule").PackageJsonRuleContext): import("jsonc-eslint-parser").RuleListener;
-        meta: import("eslint").Rule.RuleMetaData;
+    "valid-local-dependency": {
+        create(context: PackageJsonRuleContext<unknown[]>): jsonc_eslint_parser.RuleListener;
+        meta: eslint.Rule.RuleMetaData;
+    };
+    "valid-package-def": {
+        create(context: PackageJsonRuleContext<unknown[]>): jsonc_eslint_parser.RuleListener;
+        meta: eslint.Rule.RuleMetaData;
     };
 };
-export declare const configs: {
+declare const configs: {
     recommended: {
         rules: {
-            'order-properties': {
-                create(context: import("./createRule").PackageJsonRuleContext): import("jsonc-eslint-parser").RuleListener;
-                meta: import("eslint").Rule.RuleMetaData;
-            };
-            'sort-collections': {
-                create(context: import("./createRule").PackageJsonRuleContext): import("jsonc-eslint-parser").RuleListener;
-                meta: import("eslint").Rule.RuleMetaData;
-            };
-            'valid-local-dependency': {
-                create(context: import("./createRule").PackageJsonRuleContext): import("jsonc-eslint-parser").RuleListener;
-                meta: import("eslint").Rule.RuleMetaData;
-            };
-            'valid-package-def': {
-                create(context: import("./createRule").PackageJsonRuleContext): import("jsonc-eslint-parser").RuleListener;
-                meta: import("eslint").Rule.RuleMetaData;
-            };
+            [k: string]: "error";
         };
     };
 };
-//# sourceMappingURL=index.d.ts.map
+
+export { configs, rules };

package/lib/index.js

@@ -1,21 +1,59 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
 };
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.configs = exports.rules = void 0;
-const order_properties_1 = __importDefault(require("./rules/order-properties"));
-const sort_collections_1 = __importDefault(require("./rules/sort-collections"));
-const valid_local_dependency_1 = __importDefault(require("./rules/valid-local-dependency"));
-const valid_package_def_1 = __importDefault(require("./rules/valid-package-def"));
-exports.rules = {
-    'order-properties': order_properties_1.default,
-    'sort-collections': sort_collections_1.default,
-    'valid-local-dependency': valid_local_dependency_1.default,
-    'valid-package-def': valid_package_def_1.default
+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;
 };
-exports.configs = {
-    recommended: {
-        rules: exports.rules
-    }
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var src_exports = {};
+__export(src_exports, {
+  configs: () => configs,
+  rules: () => rules
+});
+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
 };
+const configs = {
+  recommended: {
+    rules: Object.fromEntries(
+      Object.entries(rules).filter(([, rule]) => rule.meta.docs?.recommended).map(([name]) => ["package-json/" + name, "error"])
+    )
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  configs,
+  rules
+});
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,24 @@
+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
+};
+const configs = {
+  recommended: {
+    rules: Object.fromEntries(
+      Object.entries(rules).filter(([, rule]) => rule.meta.docs?.recommended).map(([name]) => ["package-json/" + name, "error"])
+    )
+  }
+};
+export {
+  configs,
+  rules
+};
+//# sourceMappingURL=index.mjs.map

package/lib/index.mjs.map

@@ -0,0 +1 @@
+{"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/order-properties.d.mts

@@ -0,0 +1,15 @@
+import * as eslint from 'eslint';
+import * as jsonc_eslint_parser from 'jsonc-eslint-parser';
+import { PackageJsonRuleContext } from '../createRule.mjs';
+import 'estree';
+
+type Order = "legacy" | "sort-package-json";
+type Options = [{
+    order: Order;
+}?];
+declare const _default: {
+    create(context: PackageJsonRuleContext<Options>): jsonc_eslint_parser.RuleListener;
+    meta: eslint.Rule.RuleMetaData;
+};
+
+export { _default as default };

package/lib/rules/order-properties.d.ts

@@ -1,6 +1,15 @@
+import * as eslint from 'eslint';
+import * as jsonc_eslint_parser from 'jsonc-eslint-parser';
+import { PackageJsonRuleContext } from '../createRule.js';
+import 'estree';
+
+type Order = "legacy" | "sort-package-json";
+type Options = [{
+    order: Order;
+}?];
 declare const _default: {
-    create(context: import("../createRule.js").PackageJsonRuleContext): import("jsonc-eslint-parser").RuleListener;
-    meta: import("eslint").Rule.RuleMetaData;
+    create(context: PackageJsonRuleContext<Options>): jsonc_eslint_parser.RuleListener;
+    meta: eslint.Rule.RuleMetaData;
 };
-export default _default;
-//# sourceMappingURL=order-properties.d.ts.map
+
+export { _default as default };