eslint-plugin-package-json 0.58.0 → 0.59.0

package/CHANGELOG.md

@@ -1,11 +1,17 @@
 # Changelog
 
-# [0.58.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.57.0...v0.58.0) (2025-10-22)
+# [0.59.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.58.0...v0.59.0) (2025-10-25)
+
+
+### Features
+
+* **exports-subpaths-style:** add new rule ([#1328](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1328)) ([d1a82ed](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/d1a82edf78b7b4bd446018f1ea3bb77e1bc9c772)), closes [#1322](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1322)
 
+# [0.58.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.57.0...v0.58.0) (2025-10-22)
 
 ### Features
 
-* mark `legacy-recommended` config deprecated ([#1331](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1331)) ([5e20411](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/5e204118f4b6ae4a50f9a50a1c2a64a5bf84a5a7)), closes [#1329](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1329) [#1253](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1253)
+- mark `legacy-recommended` config deprecated ([#1331](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1331)) ([5e20411](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/5e204118f4b6ae4a50f9a50a1c2a64a5bf84a5a7)), closes [#1329](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1329) [#1253](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1253)
 
 # [0.57.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.56.4...v0.57.0) (2025-10-16)
 

package/README.md

@@ -166,6 +166,7 @@ The default settings don't conflict, and Prettier plugins can quickly fix up ord
 
 | Name                                                                       | Description                                                                                                 | 💼   | 🔧 | 💡 | ❌  |
 | :------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------- | :--- | :- | :- | :- |
+| [exports-subpaths-style](docs/rules/exports-subpaths-style.md)             | Enforce consistent format for the exports field (implicit or explicit subpaths).                            |      | 🔧 |    |    |
 | [no-empty-fields](docs/rules/no-empty-fields.md)                           | Reports on unnecessary empty arrays and objects.                                                            | ✔️ ✅ |    | 💡 |    |
 | [no-redundant-files](docs/rules/no-redundant-files.md)                     | Prevents adding unnecessary / redundant files.                                                              | ✔️ ✅ |    | 💡 |    |
 | [order-properties](docs/rules/order-properties.md)                         | Package properties must be declared in standard order                                                       | ✔️ ✅ | 🔧 |    |    |

package/lib/plugin.js

@@ -1,41 +1,43 @@
-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 { rule } from "./rules/exports-subpaths-style.js";
+import { rule as rule$1 } from "./rules/no-empty-fields.js";
+import { rule as rule$2 } from "./rules/no-redundant-files.js";
+import { rule as rule$3 } from "./rules/order-properties.js";
+import { rule as rule$4 } 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 { rule as rule$5 } from "./rules/restrict-dependency-ranges.js";
+import { rule as rule$6 } from "./rules/sort-collections.js";
+import { rule as rule$7 } from "./rules/unique-dependencies.js";
+import { rule as rule$8 } from "./rules/valid-bin.js";
+import { rule as rule$9 } from "./rules/valid-local-dependency.js";
+import { rule as rule$10 } from "./rules/valid-name.js";
+import { rule as rule$11 } 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 { rule as rule$12 } from "./rules/valid-repository-directory.js";
+import { rule as rule$13 } from "./rules/valid-version.js";
 import { createRequire } from "node:module";
 import * as parserJsonc from "jsonc-eslint-parser";
 
 //#region src/plugin.ts
 const { name, version } = createRequire(import.meta.url)("../package.json");
 const rules$2 = {
-	"no-empty-fields": rule,
-	"no-redundant-files": rule$1,
-	"order-properties": rule$2,
+	"exports-subpaths-style": rule,
+	"no-empty-fields": rule$1,
+	"no-redundant-files": rule$2,
+	"order-properties": rule$3,
 	...rules,
-	"repository-shorthand": rule$3,
-	"restrict-dependency-ranges": rule$4,
-	"sort-collections": rule$5,
-	"unique-dependencies": rule$6,
+	"repository-shorthand": rule$4,
+	"restrict-dependency-ranges": rule$5,
+	"sort-collections": rule$6,
+	"unique-dependencies": rule$7,
 	...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
+	"valid-bin": rule$8,
+	"valid-local-dependency": rule$9,
+	"valid-name": rule$10,
+	"valid-package-definition": rule$11,
+	"valid-repository-directory": rule$12,
+	"valid-version": rule$13
 };
-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 baseRecommendedRules = { ...Object.fromEntries(Object.entries(rules$2).filter(([, rule$14]) => rule$14.meta.docs?.recommended).map(([name$1]) => ["package-json/" + name$1, "error"])) };
 const recommendedRules = {
 	...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-", "")) }]

package/lib/rules/exports-subpaths-style.d.ts

@@ -0,0 +1,18 @@
+import { PackageJsonRuleModule } from "../createRule.js";
+
+//#region src/rules/exports-subpaths-style.d.ts
+declare const rule: PackageJsonRuleModule<[({
+  prefer?: "explicit" | "implicit" | undefined;
+} | undefined)?], [{
+  readonly additionalProperties: false;
+  readonly properties: {
+    readonly prefer: {
+      readonly description: "Specifies which exports format to enforce.";
+      readonly enum: readonly ["implicit", "explicit"];
+      readonly type: "string";
+    };
+  };
+  readonly type: "object";
+}]>;
+//#endregion
+export { rule };

package/lib/rules/exports-subpaths-style.js

@@ -0,0 +1,73 @@
+import { createRule } from "../createRule.js";
+import { isJSONStringLiteral } from "../utils/predicates.js";
+
+//#region src/rules/exports-subpaths-style.ts
+function isImplicitFormat(node) {
+	if (node.type === "JSONLiteral") return true;
+	return node.properties.every((property) => !isJSONStringLiteral(property.key) || !property.key.value.startsWith("."));
+}
+const rule = createRule({
+	create(context) {
+		const [{ prefer = "explicit" } = {}] = context.options;
+		function validateForExplicit(node) {
+			const { value } = node;
+			if (value.type !== "JSONLiteral" && value.type !== "JSONObjectExpression" || !isImplicitFormat(value)) return;
+			context.report({
+				fix(fixer) {
+					const valueText = context.sourceCode.getText(value);
+					const fixedValue = JSON.stringify({ ".": JSON.parse(valueText) }, null, 2);
+					return fixer.replaceText(value, fixedValue);
+				},
+				messageId: "preferExplicit",
+				node: value
+			});
+		}
+		function validateForImplicit(node) {
+			const { value } = node;
+			if (value.type !== "JSONObjectExpression") return;
+			if (value.properties.length !== 1 || !isJSONStringLiteral(value.properties[0].key) || value.properties[0].key.value !== ".") return;
+			const dotProperty = value.properties[0];
+			context.report({
+				fix(fixer) {
+					const valueText = context.sourceCode.getText(dotProperty.value);
+					const fixedValue = JSON.stringify(JSON.parse(valueText), null, 2);
+					return fixer.replaceText(value, fixedValue);
+				},
+				messageId: "preferImplicit",
+				node: value
+			});
+		}
+		return { JSONProperty(node) {
+			if (node.key.type !== "JSONLiteral" || node.key.value !== "exports" || node.parent.parent.parent.type !== "Program") return;
+			if (prefer === "explicit") validateForExplicit(node);
+			else validateForImplicit(node);
+		} };
+	},
+	meta: {
+		defaultOptions: [{ prefer: "explicit" }],
+		docs: {
+			category: "Best Practices",
+			description: "Enforce consistent format for the exports field (implicit or explicit subpaths).",
+			recommended: false
+		},
+		fixable: "code",
+		messages: {
+			preferExplicit: "Prefer explicit subpaths format with \".\" key for single root export.",
+			preferImplicit: "Prefer implicit format without \".\" key for single root export."
+		},
+		schema: [{
+			additionalProperties: false,
+			properties: { prefer: {
+				description: "Specifies which exports format to enforce.",
+				enum: ["implicit", "explicit"],
+				type: "string"
+			} },
+			type: "object"
+		}],
+		type: "suggestion"
+	},
+	name: "exports-subpaths-style"
+});
+
+//#endregion
+export { rule };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "eslint-plugin-package-json",
-	"version": "0.58.0",
+	"version": "0.59.0",
 	"description": "Rules for consistent, readable, and valid package.json files. 🗂️",
 	"homepage": "https://github.com/JoshuaKGoldberg/eslint-plugin-package-json#readme",
 	"bugs": {
@@ -56,7 +56,7 @@
 	},
 	"devDependencies": {
 		"@eslint-community/eslint-plugin-eslint-comments": "4.5.0",
-		"@eslint/js": "9.37.0",
+		"@eslint/js": "9.38.0",
 		"@release-it/conventional-changelog": "10.0.0",
 		"@types/estree": "1.0.7",
 		"@types/node": "22.18.0",
@@ -65,7 +65,7 @@
 		"@vitest/coverage-v8": "3.2.0",
 		"@vitest/eslint-plugin": "1.3.3",
 		"console-fail-test": "0.5.0",
-		"eslint": "9.37.0",
+		"eslint": "9.38.0",
 		"eslint-doc-generator": "2.3.0",
 		"eslint-plugin-eslint-plugin": "7.0.0",
 		"eslint-plugin-jsdoc": "61.1.0",
@@ -78,7 +78,7 @@
 		"jiti": "2.6.0",
 		"json-schema-to-ts": "3.1.1",
 		"jsonc-eslint-parser": "2.4.1",
-		"knip": "5.65.0",
+		"knip": "5.66.0",
 		"lint-staged": "16.2.0",
 		"markdownlint": "0.39.0",
 		"markdownlint-cli": "0.45.0",