eslint-plugin-package-json 1.2.0 → 1.3.0

package/README.md

@@ -43,6 +43,7 @@ See [Getting Started](https://eslint-plugin-package-json.dev/getting-started) fo
 | [bin-name-casing](https://eslint-plugin-package-json.dev/rules/bin-name-casing)                                                 | Enforce that names for bin properties are in kebab case.                                                                                                                                     | 🎨    |     | 💡  |
 | [exports-subpaths-style](https://eslint-plugin-package-json.dev/rules/exports-subpaths-style)                                   | Enforce consistent format for the exports field (implicit or explicit subpaths).                                                                                                             | 🎨    | 🔧  |     |
 | [no-empty-fields](https://eslint-plugin-package-json.dev/rules/no-empty-fields)                                                 | Reports on unnecessary empty arrays and objects.                                                                                                                                             | ✅ 📦 |     | 💡  |
+| [no-local-dependencies](https://eslint-plugin-package-json.dev/rules/no-local-dependencies)                                     | Requires that dependencies do not use local file paths, which will likely result in errors when installing from a registry.                                                                  |       |     |     |
 | [no-redundant-files](https://eslint-plugin-package-json.dev/rules/no-redundant-files)                                           | Prevents adding unnecessary / redundant files.                                                                                                                                               | ✅ 📦 |     | 💡  |
 | [no-redundant-publishConfig](https://eslint-plugin-package-json.dev/rules/no-redundant-publishConfig)                           | Warns when publishConfig.access is used in unscoped packages.                                                                                                                                | ✅ 📦 |     | 💡  |
 | [order-properties](https://eslint-plugin-package-json.dev/rules/order-properties)                                               | Package properties should be declared in standard order                                                                                                                                      | 🎨    | 🔧  |     |

package/lib/plugin.mjs

@@ -1,22 +1,23 @@
 import { rule } from "./rules/bin-name-casing.mjs";
 import { rule as rule$1 } from "./rules/exports-subpaths-style.mjs";
 import { rule as rule$2 } from "./rules/no-empty-fields.mjs";
-import { rule as rule$3 } from "./rules/no-redundant-files.mjs";
-import { rule as rule$4 } from "./rules/no-redundant-publishConfig.mjs";
-import { rule as rule$5 } from "./rules/order-properties.mjs";
-import { rule as rule$6 } from "./rules/repository-shorthand.mjs";
-import { rule as rule$7 } from "./rules/require-attribution.mjs";
+import { rule as rule$3 } from "./rules/no-local-dependencies.mjs";
+import { rule as rule$4 } from "./rules/no-redundant-files.mjs";
+import { rule as rule$5 } from "./rules/no-redundant-publishConfig.mjs";
+import { rule as rule$6 } from "./rules/order-properties.mjs";
+import { rule as rule$7 } from "./rules/repository-shorthand.mjs";
+import { rule as rule$8 } from "./rules/require-attribution.mjs";
 import { rules as rules$1 } from "./rules/require-properties.mjs";
-import { rule as rule$8 } from "./rules/restrict-dependency-ranges.mjs";
-import { rule as rule$9 } from "./rules/restrict-private-properties.mjs";
-import { rule as rule$10 } from "./rules/restrict-top-level-properties.mjs";
-import { rule as rule$11 } from "./rules/scripts-name-casing.mjs";
-import { rule as rule$12 } from "./rules/sort-collections.mjs";
-import { rule as rule$13 } from "./rules/specify-peers-locally.mjs";
-import { rule as rule$14 } from "./rules/unique-dependencies.mjs";
-import { rule as rule$15 } from "./rules/valid-peerDependenciesMeta-relationship.mjs";
+import { rule as rule$9 } from "./rules/restrict-dependency-ranges.mjs";
+import { rule as rule$10 } from "./rules/restrict-private-properties.mjs";
+import { rule as rule$11 } from "./rules/restrict-top-level-properties.mjs";
+import { rule as rule$12 } from "./rules/scripts-name-casing.mjs";
+import { rule as rule$13 } from "./rules/sort-collections.mjs";
+import { rule as rule$14 } from "./rules/specify-peers-locally.mjs";
+import { rule as rule$15 } from "./rules/unique-dependencies.mjs";
+import { rule as rule$16 } from "./rules/valid-peerDependenciesMeta-relationship.mjs";
 import { rules as rules$2 } from "./rules/valid-properties.mjs";
-import { rule as rule$16 } from "./rules/valid-repository-directory.mjs";
+import { rule as rule$17 } from "./rules/valid-repository-directory.mjs";
 import { createRequire } from "node:module";
 import * as parserJsonc from "jsonc-eslint-parser";
 //#region src/plugin.ts
@@ -25,22 +26,23 @@ const rules = {
 	"bin-name-casing": rule,
 	"exports-subpaths-style": rule$1,
 	"no-empty-fields": rule$2,
-	"no-redundant-files": rule$3,
-	"no-redundant-publishConfig": rule$4,
-	"order-properties": rule$5,
-	"require-attribution": rule$7,
+	"no-local-dependencies": rule$3,
+	"no-redundant-files": rule$4,
+	"no-redundant-publishConfig": rule$5,
+	"order-properties": rule$6,
+	"require-attribution": rule$8,
 	...rules$1,
-	"repository-shorthand": rule$6,
-	"restrict-dependency-ranges": rule$8,
-	"restrict-private-properties": rule$9,
-	"restrict-top-level-properties": rule$10,
-	"scripts-name-casing": rule$11,
-	"sort-collections": rule$12,
-	"specify-peers-locally": rule$13,
-	"unique-dependencies": rule$14,
+	"repository-shorthand": rule$7,
+	"restrict-dependency-ranges": rule$9,
+	"restrict-private-properties": rule$10,
+	"restrict-top-level-properties": rule$11,
+	"scripts-name-casing": rule$12,
+	"sort-collections": rule$13,
+	"specify-peers-locally": rule$14,
+	"unique-dependencies": rule$15,
 	...rules$2,
-	"valid-peerDependenciesMeta-relationship": rule$15,
-	"valid-repository-directory": rule$16
+	"valid-peerDependenciesMeta-relationship": rule$16,
+	"valid-repository-directory": rule$17
 };
 const recommendedRules = { ...Object.fromEntries(Object.entries(rules).filter(([, rule]) => rule.meta.docs?.recommended).map(([name]) => ["package-json/" + name, "error"])) };
 const recommendedPublishableRules = {

package/lib/rules/no-local-dependencies.d.mts

@@ -0,0 +1,17 @@
+import { PackageJsonRuleModule } from "../createRule.mjs";
+
+//#region src/rules/no-local-dependencies.d.ts
+declare const rule: PackageJsonRuleModule<[({
+  ignorePrivate?: boolean | undefined;
+} | undefined)?], [{
+  readonly additionalProperties: false;
+  readonly properties: {
+    readonly ignorePrivate: {
+      readonly description: "Determines if this rule should be enforced when the package's `private` property is `true`.";
+      readonly type: "boolean";
+    };
+  };
+  readonly type: "object";
+}]>;
+//#endregion
+export { rule };

package/lib/rules/no-local-dependencies.mjs

@@ -0,0 +1,47 @@
+import { createRule } from "../createRule.mjs";
+import { isJSONStringLiteral } from "../utils/predicates.mjs";
+//#region src/rules/no-local-dependencies.ts
+const isLocalDependency = (value) => value.startsWith("file:") || value.startsWith("link:") || value.startsWith("./") || value.startsWith("../") || value.startsWith(".\\") || value.startsWith("..\\");
+const rule = createRule({
+	create(context) {
+		const ignorePrivate = context.options[0]?.ignorePrivate ?? true;
+		let isPrivate = false;
+		let dependencyNodes = [];
+		return {
+			"Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.type=JSONLiteral][value.type=JSONLiteral][key.value=private]"(node) {
+				if (node.value.value === true) isPrivate = true;
+			},
+			"Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.type=JSONLiteral][value.type=JSONObjectExpression][key.value=dependencies]"(node) {
+				dependencyNodes = node.value.properties;
+			},
+			"Program:exit"() {
+				if (ignorePrivate && isPrivate) return;
+				for (const dependencyPropertyNode of dependencyNodes) {
+					const dependencyValue = dependencyPropertyNode.value;
+					if (isJSONStringLiteral(dependencyValue) && isLocalDependency(dependencyValue.value)) context.report({
+						data: { name: dependencyValue.value },
+						messageId: "localDependencyFound",
+						node: dependencyValue
+					});
+				}
+			}
+		};
+	},
+	meta: {
+		defaultOptions: [{ ignorePrivate: true }],
+		docs: { description: "Requires that dependencies do not use local file paths, which will likely result in errors when installing from a registry." },
+		messages: { localDependencyFound: "Local dependency \"{{ name }}\" is not allowed." },
+		schema: [{
+			additionalProperties: false,
+			properties: { ignorePrivate: {
+				description: "Determines if this rule should be enforced when the package's `private` property is `true`.",
+				type: "boolean"
+			} },
+			type: "object"
+		}],
+		type: "problem"
+	},
+	name: "no-local-dependencies"
+});
+//#endregion
+export { rule };

package/lib/rules/valid-repository-directory.mjs

@@ -1,8 +1,8 @@
 import { createRule } from "../createRule.mjs";
 import { findPropertyWithKeyValue } from "../utils/findPropertyWithKeyValue.mjs";
-import { findRootSync } from "@altano/repository-tools";
 import path from "node:path";
 import { sep } from "node:path/posix";
+import { findRootSync } from "@altano/repository-tools";
 //#region src/rules/valid-repository-directory.ts
 /**
 * Checks if the child path appears at the end of the parent path.
@@ -11,7 +11,7 @@ import { sep } from "node:path/posix";
 * @example '/a/b/c', 'b' => false
 * @example '/a/b/c', 'd' => false
 */
-function pathEndsWith(parent, child) {
+const pathEndsWith = (parent, child) => {
 	const segments = parent.split(path.sep);
 	if (parent === child) return true;
 	let pathToCheck = "";
@@ -19,7 +19,8 @@ function pathEndsWith(parent, child) {
 		pathToCheck = path.join(segment, pathToCheck);
 		if (pathToCheck === child) return true;
 	});
-}
+};
+let repoRootCache = null;
 const rule = createRule({
 	create(context) {
 		return { "Program > JSONExpressionStatement > JSONObjectExpression > JSONProperty[key.value=repository][value.type=JSONObjectExpression]"(node) {
@@ -27,13 +28,13 @@ const rule = createRule({
 			if (directoryProperty?.value.type !== "JSONLiteral" || typeof directoryProperty.value.value !== "string") return;
 			const directoryValue = directoryProperty.value.value;
 			const fileDirectory = path.normalize(path.dirname(context.filename));
-			const repositoryRoot = findRootSync(fileDirectory);
-			if (repositoryRoot == null) {
-				if (!pathEndsWith(fileDirectory, path.normalize(directoryValue))) context.report({
-					messageId: "mismatched",
-					node: directoryProperty.value
-				});
-			} else {
+			let repositoryRoot;
+			if (repoRootCache && fileDirectory.startsWith(repoRootCache)) repositoryRoot = repoRootCache;
+			else {
+				repositoryRoot = findRootSync(fileDirectory);
+				if (repositoryRoot) repoRootCache = path.normalize(repositoryRoot);
+			}
+			if (repositoryRoot) {
 				const expected = path.relative(repositoryRoot, fileDirectory).replaceAll(path.sep, sep);
 				if (expected !== directoryValue) context.report({
 					messageId: "mismatched",
@@ -46,7 +47,10 @@ const rule = createRule({
 						messageId: "replace"
 					}]
 				});
-			}
+			} else if (!pathEndsWith(fileDirectory, path.normalize(directoryValue))) context.report({
+				messageId: "mismatched",
+				node: directoryProperty.value
+			});
 		} };
 	},
 	meta: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-package-json",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Rules for consistent, readable, and valid package.json files. 🗂️",
   "homepage": "https://github.com/michaelfaith/eslint-plugin-package-json#readme",
   "bugs": {
@@ -60,14 +60,15 @@
     "@catppuccin/starlight": "2.0.1",
     "@eslint-community/eslint-plugin-eslint-comments": "4.7.0",
     "@eslint/js": "10.0.1",
-    "@eslint/json": "1.2.0",
+    "@eslint/json": "2.0.0",
     "@eslint/markdown": "8.0.1",
+    "@ianvs/prettier-plugin-sort-imports": "4.7.1",
     "@types/estree": "1.0.8",
     "@types/node": "24.12.0",
     "@types/semver": "7.7.1",
     "@vitest/coverage-v8": "4.1.0",
     "@vitest/eslint-plugin": "1.6.1",
-    "astro": "6.3.0",
+    "astro": "6.4.2",
     "astro-og-canvas": "0.11.1",
     "canvaskit-wasm": "0.41.1",
     "console-fail-test": "0.6.0",
@@ -75,13 +76,13 @@
     "eslint-doc-generator": "3.6.0",
     "eslint-plugin-eslint-plugin": "7.3.1",
     "eslint-plugin-jsdoc": "63.0.0",
-    "eslint-plugin-jsonc": "3.1.0",
+    "eslint-plugin-jsonc": "3.2.0",
     "eslint-plugin-n": "18.0.0",
     "eslint-plugin-node-dependencies": "2.2.0",
     "eslint-plugin-perfectionist": "5.9.0",
     "eslint-plugin-regexp": "3.1.0",
     "eslint-plugin-unicorn": "64.0.0",
-    "eslint-plugin-yml": "3.3.0",
+    "eslint-plugin-yml": "3.4.0",
     "jiti": "2.7.0",
     "json-schema-to-ts": "3.1.1",
     "knip": "6.14.0",