eslint-plugin-package-json 0.52.1 → 0.54.0

package/CHANGELOG.md

@@ -1,11 +1,23 @@
 # Changelog
 
-## [0.52.1](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.52.0...v0.52.1) (2025-08-07)
+# [0.54.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.53.0...v0.54.0) (2025-08-15)
+
+
+### Features
+
+* **valid-exports:** add new rule for validating `exports` ([#1220](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1220)) ([2af10da](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/2af10dae3398832819c6dd37730ffef5ee3329b7)), closes [#1033](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1033)
 
+# [0.53.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.52.1...v0.53.0) (2025-08-13)
+
+### Features
+
+- add docs url to all rules ([#1218](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1218)) ([d456b13](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/d456b13d2c30e71d11294a315282859c66a4b1b7)), closes [#1217](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1217)
+
+## [0.52.1](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.52.0...v0.52.1) (2025-08-07)
 
 ### Bug Fixes
 
-* **sort-collections:** align sorting of scripts with `prettier-plugin-packagejson` ([#1203](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1203)) ([1f5c590](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/1f5c590adc846194766127ab962f8efa72942d06)), closes [#753](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/753)
+- **sort-collections:** align sorting of scripts with `prettier-plugin-packagejson` ([#1203](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1203)) ([1f5c590](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/1f5c590adc846194766127ab962f8efa72942d06)), closes [#753](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/753)
 
 # [0.52.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.51.0...v0.52.0) (2025-08-07)
 

package/README.md

@@ -185,6 +185,7 @@ The default settings don't conflict, and Prettier plugins can quickly fix up ord
 | [valid-dependencies](docs/rules/valid-dependencies.md)                     | Enforce that the `dependencies` property is valid.                                                | ✔️ ✅ |    |    |    |
 | [valid-description](docs/rules/valid-description.md)                       | Enforce that the `description` property is valid.                                                 | ✔️ ✅ |    |    |    |
 | [valid-devDependencies](docs/rules/valid-devDependencies.md)               | Enforce that the `devDependencies` property is valid.                                             | ✔️ ✅ |    |    |    |
+| [valid-exports](docs/rules/valid-exports.md)                               | Enforce that the `exports` property is valid.                                                     | ✔️ ✅ |    |    |    |
 | [valid-license](docs/rules/valid-license.md)                               | Enforce that the `license` property is valid.                                                     | ✔️ ✅ |    |    |    |
 | [valid-local-dependency](docs/rules/valid-local-dependency.md)             | Checks existence of local dependencies in the package.json                                        |      |    |    | ❌  |
 | [valid-name](docs/rules/valid-name.md)                                     | Enforce that package names are valid npm package names                                            | ✔️ ✅ |    |    |    |

package/lib/createRule.d.ts

@@ -1,45 +1,45 @@
-import * as ESTree from 'estree';
-import { AST as AST$1, Rule, SourceCode } from 'eslint';
-import { AST, RuleListener } from 'jsonc-eslint-parser';
+import { AST, RuleListener } from "jsonc-eslint-parser";
+import * as ESTree from "estree";
+import { AST as AST$1, Rule, SourceCode } from "eslint";
 
+//#region src/createRule.d.ts
 type JsonAstBodyExpression = ESTree.Expression & {
-    properties: JsonAstBodyProperty[];
+  properties: JsonAstBodyProperty[];
 };
 type JsonAstBodyProperty = AST.JSONProperty & {
-    value: string;
+  value: string;
 };
 interface JsonAstBodyStatement extends ESTree.ExpressionStatement {
-    expression: JsonAstBodyExpression;
+  expression: JsonAstBodyExpression;
 }
 interface PackageJsonAst extends AST$1.Program {
-    body: [JsonAstBodyStatement];
+  body: [JsonAstBodyStatement];
 }
 interface PackageJsonPluginSettings {
-    /**
-     * Whether `require-*` rules, if used, should enforce the presence of
-     * the corresponding property *in package.json files with `"private": true`*.
-     *
-     * If not specified, it will not enforce the presence only of `name` and `version` properties.
-     */
-    enforceForPrivate?: boolean;
+  /**
+   * Whether `require-*` rules, if used, should enforce the presence of
+   * the corresponding property *in package.json files with `"private": true`*.
+   *
+   * If not specified, it will not enforce the presence only of `name` and `version` properties.
+   */
+  enforceForPrivate?: boolean;
 }
 interface PackageJsonRuleContext<Options extends unknown[] = unknown[]> extends Rule.RuleContext {
-    options: Options;
-    settings: {
-        packageJson?: PackageJsonPluginSettings;
-    };
-    sourceCode: PackageJsonSourceCode;
+  options: Options;
+  settings: {
+    packageJson?: PackageJsonPluginSettings;
+  };
+  sourceCode: PackageJsonSourceCode;
 }
 interface PackageJsonRuleModule<Options extends unknown[] = unknown[]> {
-    create(context: PackageJsonRuleContext<Options>): RuleListener;
-    meta: Rule.RuleMetaData;
+  create(context: PackageJsonRuleContext<Options>): RuleListener;
+  meta: Rule.RuleMetaData;
 }
 interface PackageJsonSourceCode extends SourceCode {
-    ast: PackageJsonAst;
+  ast: PackageJsonAst;
 }
-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 PackageJsonPluginSettings, type PackageJsonRuleContext, type PackageJsonRuleModule, type PackageJsonSourceCode, createRule };
+declare function createRule<Options extends unknown[]>(rule: PackageJsonRuleModule<Options> & {
+  name: string;
+}): PackageJsonRuleModule<Options>;
+//#endregion
+export { JsonAstBodyExpression, JsonAstBodyProperty, JsonAstBodyStatement, PackageJsonAst, PackageJsonPluginSettings, PackageJsonRuleContext, PackageJsonRuleModule, PackageJsonSourceCode, createRule };

package/lib/createRule.js

@@ -1,15 +1,21 @@
 import { isPackageJson } from "./utils/isPackageJson.js";
+
+//#region src/createRule.ts
 function createRule(rule) {
-  return {
-    ...rule,
-    create(context) {
-      if (!isPackageJson(context.filename)) {
-        return {};
-      }
-      return rule.create(context);
-    }
-  };
+	return {
+		create(context) {
+			if (!isPackageJson(context.filename)) return {};
+			return rule.create(context);
+		},
+		meta: {
+			...rule.meta,
+			docs: {
+				...rule.meta.docs,
+				url: `https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/blob/HEAD/docs/rules/${rule.name}.md`
+			}
+		}
+	};
 }
-export {
-  createRule
-};
+
+//#endregion
+export { createRule };

package/lib/index.d.ts

@@ -1,42 +1,40 @@
-import * as jsonc_eslint_parser from 'jsonc-eslint-parser';
-import { PackageJsonRuleModule } from './createRule.js';
-export { PackageJsonPluginSettings } from './createRule.js';
-import { plugin } from './plugin.js';
-import 'estree';
-import 'eslint';
+import { PackageJsonPluginSettings, PackageJsonRuleModule } from "./createRule.js";
+import { plugin } from "./plugin.js";
+import * as jsonc_eslint_parser0 from "jsonc-eslint-parser";
 
+//#region src/index.d.ts
 declare const rules: Record<string, PackageJsonRuleModule<unknown[]>>;
 declare const configs: {
-    "legacy-recommended": {
-        plugins: string[];
-        rules: {
-            "package-json/valid-package-definition": ["error", {
-                ignoreProperties: string[];
-            }];
-        };
+  "legacy-recommended": {
+    plugins: string[];
+    rules: {
+      "package-json/valid-package-definition": ["error", {
+        ignoreProperties: string[];
+      }];
     };
-    recommended: {
-        files: string[];
-        languageOptions: {
-            parser: typeof jsonc_eslint_parser;
-        };
-        name: string;
-        plugins: {
-            readonly "package-json": {
-                configs: /*elided*/ any;
-                meta: {
-                    name: string;
-                    version: string;
-                };
-                rules: Record<string, PackageJsonRuleModule<unknown[]>>;
-            };
-        };
-        rules: {
-            "package-json/valid-package-definition": ["error", {
-                ignoreProperties: string[];
-            }];
+  };
+  recommended: {
+    files: string[];
+    languageOptions: {
+      parser: typeof jsonc_eslint_parser0;
+    };
+    name: string;
+    plugins: {
+      readonly "package-json": {
+        configs: /*elided*/any;
+        meta: {
+          name: string;
+          version: string;
         };
+        rules: Record<string, PackageJsonRuleModule<unknown[]>>;
+      };
+    };
+    rules: {
+      "package-json/valid-package-definition": ["error", {
+        ignoreProperties: string[];
+      }];
     };
+  };
 };
-
-export { configs, plugin as default, rules };
+//#endregion
+export { type PackageJsonPluginSettings, configs, plugin as default, rules };

package/lib/index.js

@@ -1,9 +1,9 @@
 import { plugin } from "./plugin.js";
+
+//#region src/index.ts
 const rules = plugin.rules;
 const configs = plugin.configs;
-var index_default = plugin;
-export {
-  configs,
-  index_default as default,
-  rules
-};
+var src_default = plugin;
+
+//#endregion
+export { configs, src_default as default, rules };

package/lib/plugin.d.ts

@@ -1,39 +1,38 @@
-import * as jsonc_eslint_parser from 'jsonc-eslint-parser';
-import { PackageJsonRuleModule } from './createRule.js';
-import 'estree';
-import 'eslint';
+import { PackageJsonRuleModule } from "./createRule.js";
+import * as parserJsonc from "jsonc-eslint-parser";
 
+//#region src/plugin.d.ts
 declare const plugin: {
-    configs: {
-        "legacy-recommended": {
-            plugins: string[];
-            rules: {
-                "package-json/valid-package-definition": ["error", {
-                    ignoreProperties: string[];
-                }];
-            };
-        };
-        recommended: {
-            files: string[];
-            languageOptions: {
-                parser: typeof jsonc_eslint_parser;
-            };
-            name: string;
-            plugins: {
-                readonly "package-json": /*elided*/ any;
-            };
-            rules: {
-                "package-json/valid-package-definition": ["error", {
-                    ignoreProperties: string[];
-                }];
-            };
-        };
+  configs: {
+    "legacy-recommended": {
+      plugins: string[];
+      rules: {
+        "package-json/valid-package-definition": ["error", {
+          ignoreProperties: string[];
+        }];
+      };
     };
-    meta: {
-        name: string;
-        version: string;
+    recommended: {
+      files: string[];
+      languageOptions: {
+        parser: typeof parserJsonc;
+      };
+      name: string;
+      plugins: {
+        readonly "package-json": /*elided*/any;
+      };
+      rules: {
+        "package-json/valid-package-definition": ["error", {
+          ignoreProperties: string[];
+        }];
+      };
     };
-    rules: Record<string, PackageJsonRuleModule<unknown[]>>;
+  };
+  meta: {
+    name: string;
+    version: string;
+  };
+  rules: Record<string, PackageJsonRuleModule<unknown[]>>;
 };
-
-export { plugin };
+//#endregion
+export { plugin };

package/lib/plugin.js

@@ -1,86 +1,68 @@
-import * as parserJsonc from "jsonc-eslint-parser";
+import { rule } from "./rules/no-empty-fields.js";
+import { rule as rule$1 } from "./rules/no-redundant-files.js";
+import { rule as rule$2 } from "./rules/order-properties.js";
+import { rule as rule$3 } from "./rules/repository-shorthand.js";
+import { rules } from "./rules/require-properties.js";
+import { rule as rule$4 } from "./rules/restrict-dependency-ranges.js";
+import { rule as rule$5 } from "./rules/sort-collections.js";
+import { rule as rule$6 } from "./rules/unique-dependencies.js";
+import { rule as rule$7 } from "./rules/valid-bin.js";
+import { rule as rule$8 } from "./rules/valid-local-dependency.js";
+import { rule as rule$9 } from "./rules/valid-name.js";
+import { rule as rule$10 } from "./rules/valid-package-definition.js";
+import { rules as rules$1 } from "./rules/valid-properties.js";
+import { rule as rule$11 } from "./rules/valid-repository-directory.js";
+import { rule as rule$12 } from "./rules/valid-version.js";
 import { createRequire } from "node:module";
-import { rule as noEmptyFields } from "./rules/no-empty-fields.js";
-import { rule as noRedundantFiles } from "./rules/no-redundant-files.js";
-import { rule as orderProperties } from "./rules/order-properties.js";
-import { rule as preferRepositoryShorthand } from "./rules/repository-shorthand.js";
-import { rules as requireRules } from "./rules/require-properties.js";
-import { rule as restrictDependencyRanges } from "./rules/restrict-dependency-ranges.js";
-import { rule as sortCollections } from "./rules/sort-collections.js";
-import { rule as uniqueDependencies } from "./rules/unique-dependencies.js";
-import { rule as validBin } from "./rules/valid-bin.js";
-import { rule as validLocalDependency } from "./rules/valid-local-dependency.js";
-import { rule as validName } from "./rules/valid-name.js";
-import { rule as validPackageDefinition } from "./rules/valid-package-definition.js";
-import { rules as basicValidRules } from "./rules/valid-properties.js";
-import { rule as validRepositoryDirectory } from "./rules/valid-repository-directory.js";
-import { rule as validVersion } from "./rules/valid-version.js";
-const require2 = createRequire(import.meta.url);
-const { name, version } = require2("../package.json");
-const rules = {
-  "no-empty-fields": noEmptyFields,
-  "no-redundant-files": noRedundantFiles,
-  "order-properties": orderProperties,
-  ...requireRules,
-  "repository-shorthand": preferRepositoryShorthand,
-  "restrict-dependency-ranges": restrictDependencyRanges,
-  "sort-collections": sortCollections,
-  "unique-dependencies": uniqueDependencies,
-  ...basicValidRules,
-  "valid-bin": validBin,
-  "valid-local-dependency": validLocalDependency,
-  "valid-name": validName,
-  "valid-package-definition": validPackageDefinition,
-  "valid-repository-directory": validRepositoryDirectory,
-  "valid-version": validVersion
-};
-const baseRecommendedRules = {
-  ...Object.fromEntries(
-    Object.entries(rules).filter(([, rule]) => rule.meta.docs?.recommended).map(([name2]) => ["package-json/" + name2, "error"])
-  )
+import * as parserJsonc from "jsonc-eslint-parser";
+
+//#region src/plugin.ts
+const require = createRequire(import.meta.url);
+const { name, version } = require("../package.json");
+const rules$2 = {
+	"no-empty-fields": rule,
+	"no-redundant-files": rule$1,
+	"order-properties": rule$2,
+	...rules,
+	"repository-shorthand": rule$3,
+	"restrict-dependency-ranges": rule$4,
+	"sort-collections": rule$5,
+	"unique-dependencies": rule$6,
+	...rules$1,
+	"valid-bin": rule$7,
+	"valid-local-dependency": rule$8,
+	"valid-name": rule$9,
+	"valid-package-definition": rule$10,
+	"valid-repository-directory": rule$11,
+	"valid-version": rule$12
 };
+const baseRecommendedRules = { ...Object.fromEntries(Object.entries(rules$2).filter(([, rule$13]) => rule$13.meta.docs?.recommended).map(([name$1]) => ["package-json/" + name$1, "error"])) };
 const recommendedRules = {
-  ...baseRecommendedRules,
-  // As we add more `valid-*` rules, we should prevent this legacy rule from
-  // also reporting the same errors.
-  "package-json/valid-package-definition": [
-    "error",
-    {
-      // Create a list of properties to ignore based on the valid-* rules
-      // we currently have. Once we've fully covered what `valid-package-definition`
-      // checks, we can remove it from the `recommended` config entirely.
-      ignoreProperties: Object.entries(baseRecommendedRules).filter(
-        ([name2]) => name2.startsWith("package-json/valid-") && name2 !== "package-json/valid-package-definition"
-      ).map(([name2]) => name2.replace("package-json/valid-", ""))
-    }
-  ]
+	...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 plugin = {
-  configs: {
-    "legacy-recommended": {
-      plugins: ["package-json"],
-      rules: recommendedRules
-    },
-    recommended: {
-      files: ["**/package.json"],
-      languageOptions: {
-        parser: parserJsonc
-      },
-      name: "package-json/recommended",
-      plugins: {
-        get "package-json"() {
-          return plugin;
-        }
-      },
-      rules: recommendedRules
-    }
-  },
-  meta: {
-    name,
-    version
-  },
-  rules
-};
-export {
-  plugin
+	configs: {
+		"legacy-recommended": {
+			plugins: ["package-json"],
+			rules: recommendedRules
+		},
+		recommended: {
+			files: ["**/package.json"],
+			languageOptions: { parser: parserJsonc },
+			name: "package-json/recommended",
+			plugins: { get "package-json"() {
+				return plugin;
+			} },
+			rules: recommendedRules
+		}
+	},
+	meta: {
+		name,
+		version
+	},
+	rules: rules$2
 };
+
+//#endregion
+export { plugin };

package/lib/rules/no-empty-fields.d.ts

@@ -1,15 +1,10 @@
-import * as eslint from 'eslint';
-import * as jsonc_eslint_parser from 'jsonc-eslint-parser';
-import { PackageJsonRuleContext } from '../createRule.js';
-import 'estree';
+import { PackageJsonRuleModule } from "../createRule.js";
 
+//#region src/rules/no-empty-fields.d.ts
 interface Option {
-    ignoreProperties?: string[];
+  ignoreProperties?: string[];
 }
 type Options = [Option?];
-declare const rule: {
-    create(context: PackageJsonRuleContext<Options>): jsonc_eslint_parser.RuleListener;
-    meta: eslint.Rule.RuleMetaData;
-};
-
-export { rule };
+declare const rule: PackageJsonRuleModule<Options>;
+//#endregion
+export { rule };