eslint-plugin-package-json 0.38.0 → 0.39.0

package/CHANGELOG.md

@@ -1,11 +1,23 @@
 # Changelog
 
-# [0.38.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.37.0...v0.38.0) (2025-06-13)
+# [0.39.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.38.1...v0.39.0) (2025-06-13)
+
+
+### Features
+
+* deprecate `valid-local-dependency` ([#1107](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1107)) ([4efea70](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/4efea705124a31a35ba9e10e3bb0ef79bf442fab)), closes [#1096](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1096)
 
+## [0.38.1](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.38.0...v0.38.1) (2025-06-13)
+
+### Bug Fixes
+
+- **valid-local-dependency:** don't flag archives as invalid ([#1109](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1109)) ([3d89865](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/3d89865bba6e3ecab02576cde131336a7dc8c169)), closes [#1086](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1086)
+
+# [0.38.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.37.0...v0.38.0) (2025-06-13)
 
 ### Features
 
-* add `valid-author` rule ([#1079](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1079)) ([b8e8b40](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/b8e8b40065a0aa0bfa9e38697ab5fe3241b7d6d7)), closes [#840](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/840)
+- add `valid-author` rule ([#1079](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/1079)) ([b8e8b40](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/commit/b8e8b40065a0aa0bfa9e38697ab5fe3241b7d6d7)), closes [#840](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/issues/840)
 
 # [0.37.0](https://github.com/JoshuaKGoldberg/eslint-plugin-package-json/compare/v0.36.0...v0.37.0) (2025-06-12)
 

package/README.md

@@ -139,7 +139,7 @@ The default settings don't conflict, and Prettier plugins can quickly fix up ord
 | [unique-dependencies](docs/rules/unique-dependencies.md)               | Checks a dependency isn't specified more than once (i.e. in `dependencies` and `devDependencies`) | ✔️ ✅ |    | 💡 |    |
 | [valid-author](docs/rules/valid-author.md)                             | Enforce that the author field is a valid npm author specification                                 | ✔️ ✅ |    |    |    |
 | [valid-bin](docs/rules/valid-bin.md)                                   | Enforce that the `bin` property is valid.                                                         | ✔️ ✅ |    |    |    |
-| [valid-local-dependency](docs/rules/valid-local-dependency.md)         | Checks existence of local dependencies in the package.json                                        | ✔️ ✅ |    |    |    |
+| [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                                            | ✔️ ✅ |    |    |    |
 | [valid-package-def](docs/rules/valid-package-def.md)                   | Enforce that package.json has all properties required by the npm spec                             |      |    |    | ❌  |
 | [valid-package-definition](docs/rules/valid-package-definition.md)     | Enforce that package.json has all properties required by the npm spec                             | ✔️ ✅ |    |    |    |

package/lib/rules/valid-author.js

@@ -1,5 +1,6 @@
 import { validateAuthor } from "package-json-validator";
 import { createRule } from "../createRule.js";
+import { formatErrors } from "../utils/formatErrors.js";
 const rule = createRule({
   create(context) {
     return {
@@ -11,11 +12,9 @@ const rule = createRule({
         );
         const errors = validateAuthor(authorValue);
         if (errors.length > 0) {
-          const complaints = errors.length === 1 ? errors[0] : `
- - ${errors.join("\n - ")}`;
           context.report({
             data: {
-              complaints
+              errors: formatErrors(errors)
             },
             messageId: "invalid",
             node: node.value
@@ -31,7 +30,7 @@ const rule = createRule({
       recommended: true
     },
     messages: {
-      invalid: "Invalid author: {{ complaints }}"
+      invalid: "Invalid author: {{ errors }}"
     },
     schema: [],
     type: "problem"

package/lib/rules/valid-bin.js

@@ -1,5 +1,6 @@
 import { validateBin } from "package-json-validator";
 import { createRule } from "../createRule.js";
+import { formatErrors } from "../utils/formatErrors.js";
 const rule = createRule({
   create(context) {
     return {
@@ -14,7 +15,7 @@ const rule = createRule({
         }
         context.report({
           data: {
-            errors: errors.length > 1 ? ["", ...errors].join("\n - ") : errors[0]
+            errors: formatErrors(errors)
           },
           messageId: "validationError",
           node: binValueNode

package/lib/rules/valid-local-dependency.js

@@ -1,5 +1,7 @@
 import path from "path";
 import { createRule } from "../createRule.js";
+const fileRegex = /^file:/;
+const linkRegex = /^link:/;
 const rule = createRule({
   create(context) {
     return {
@@ -13,11 +15,10 @@ const rule = createRule({
         ];
         for (const obj of depObjs) {
           for (const [key, value] of obj) {
-            const response = (localPath) => {
+            const response = (pathToken) => {
               const filePath = path.join(
-                context.filename.replace(/package\.json/g, "/"),
-                value.replace(new RegExp(localPath, "g"), ""),
-                "/package.json"
+                context.filename.replace("package.json", ""),
+                value.replace(pathToken, "")
               );
               try {
                 require.resolve(filePath);
@@ -33,10 +34,10 @@ const rule = createRule({
               }
             };
             if (value.startsWith("link:")) {
-              response("link:");
+              response(linkRegex);
             }
             if (value.startsWith("file:")) {
-              response("file:");
+              response(fileRegex);
             }
           }
         }
@@ -44,10 +45,10 @@ const rule = createRule({
     };
   },
   meta: {
+    deprecated: true,
     docs: {
       category: "Best Practices",
-      description: "Checks existence of local dependencies in the package.json",
-      recommended: true
+      description: "Checks existence of local dependencies in the package.json"
     },
     messages: {
       invalidPath: "The package {{package}} does not exist given the specified path: {{path}}."

package/lib/utils/formatErrors.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Formats an array of error messages into a single string.
+ * When there is more than one error, the errors will be formatted as a list,
+ * starting on a new line.
+ */
+declare const formatErrors: (errors: string[]) => string;
+
+export { formatErrors };

package/lib/utils/formatErrors.js

@@ -0,0 +1,9 @@
+const formatErrors = (errors) => {
+  if (errors.length === 0) {
+    return "";
+  }
+  return errors.length > 1 ? ["", ...errors].join("\n - ") : errors[0];
+};
+export {
+  formatErrors
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "eslint-plugin-package-json",
-	"version": "0.38.0",
+	"version": "0.39.0",
 	"description": "Rules for consistent, readable, and valid package.json files. 🗂️",
 	"homepage": "https://github.com/JoshuaKGoldberg/eslint-plugin-package-json#readme",
 	"bugs": {