Check local package version consistency (#343)

Author: bmish

README.md

@@ -3,7 +3,10 @@
 [![npm version][npm-image]][npm-url]
 [![CI][ci-image]][ci-url]
 
-This CLI tool checks to ensure that dependencies are on consistent versions across a monorepo / yarn workspace. For example, every package in a workspace that has a dependency on `eslint` should specify the same version for it.
+This CLI tool enforces the following aspects of consistency across a monorepo / yarn workspace:
+
+1. Dependencies are on consistent versions. For example, every package in a workspace that has a dependency on `eslint` should specify the same version for it.
+2. Dependencies on local packages use the local packages directly instead of older versions of them. For example, if one package `package1` in a workspace depends on another package `package2` in the workspace, `package1` should request the current version of `package2`.
 
 ## Motivation
 
@@ -27,9 +30,9 @@ To run, use this command and optionally pass the path to the workspace root (whe
 yarn check-dependency-version-consistency .
 ```
 
-If there are no dependency mismatches, the program will exit with success.
+If there are no inconsistencies, the program will exit with success.
 
-If there are any dependency mismatches, the program will exit with failure and output the mismatching versions.
+If there are any inconsistencies, the program will exit with failure and output the mismatching versions.
 
 ## Example
 
@@ -57,6 +60,9 @@ If there are any dependency mismatches, the program will exit with failure and o
   "name": "package1",
   "devDependencies": {
     "eslint": "^8.0.0"
+  },
+  "dependencies": {
+    "package2": "^0.0.0"
   }
 }
 ```
@@ -66,6 +72,7 @@ If there are any dependency mismatches, the program will exit with failure and o
 ```json
 {
   "name": "package2",
+  "version": "1.0.0",
   "devDependencies": {
     "eslint": "^7.0.0"
   }
@@ -86,14 +93,21 @@ If there are any dependency mismatches, the program will exit with failure and o
 Output:
 
 ```pt
-Found 1 dependency with mismatching versions across the workspace. Fix with `--fix`.
+Found 2 dependencies with mismatching versions across the workspace. Fix with `--fix`.
 ╔════════╤════════╤════════════════════╗
 ║ eslint │ Usages │ Packages           ║
 ╟────────┼────────┼────────────────────╢
 ║ ^8.0.0 │ 1      │ package1           ║
 ╟────────┼────────┼────────────────────╢
 ║ ^7.0.0 │ 2      │ package2, package3 ║
 ╚════════╧════════╧════════════════════╝
+╔══════════╤════════╤══════════╗
+║ package2 │ Usages │ Packages ║
+╟──────────┼────────┼──────────╢
+║ 1.0.0    │ 1      │ package2 ║
+╟──────────┼────────┼──────────╢
+║ ^0.0.0   │ 1      │ package1 ║
+╚══════════╧════════╧══════════╝
 ```
 
 ## Options

lib/dependency-versions.ts

@@ -4,7 +4,7 @@ import { Package } from './package.js';
 
 export type DependenciesToVersionsSeen = Map<
   string,
-  { package: Package; version: string }[]
+  { package: Package; version: string; isLocalPackageVersion: boolean }[]
 >;
 
 export type MismatchingDependencyVersions = Array<{
@@ -36,7 +36,7 @@ export function calculateVersionsForEachDependency(
 ): DependenciesToVersionsSeen {
   const dependenciesToVersionsSeen: DependenciesToVersionsSeen = new Map<
     string,
-    { package: Package; version: string }[]
+    { package: Package; version: string; isLocalPackageVersion: boolean }[]
   >();
   for (const package_ of packages) {
     recordDependencyVersionsForPackageJson(
@@ -51,6 +51,16 @@ function recordDependencyVersionsForPackageJson(
   dependenciesToVersionsSeen: DependenciesToVersionsSeen,
   package_: Package
 ) {
+  if (package_.packageJson.name && package_.packageJson.version) {
+    recordDependencyVersion(
+      dependenciesToVersionsSeen,
+      package_.packageJson.name,
+      package_.packageJson.version,
+      package_,
+      true
+    );
+  }
+
   if (package_.packageJson.dependencies) {
     for (const [dependency, dependencyVersion] of Object.entries(
       package_.packageJson.dependencies
@@ -82,7 +92,8 @@ function recordDependencyVersion(
   dependenciesToVersionsSeen: DependenciesToVersionsSeen,
   dependency: string,
   version: string,
-  package_: Package
+  package_: Package,
+  isLocalPackageVersion = false
 ) {
   if (!dependenciesToVersionsSeen.has(dependency)) {
     dependenciesToVersionsSeen.set(dependency, []);
@@ -91,41 +102,79 @@ function recordDependencyVersion(
   /* istanbul ignore if */
   if (list) {
     // `list` should always exist at this point, this if statement is just to please TypeScript.
-    list.push({ package: package_, version });
+    list.push({ package: package_, version, isLocalPackageVersion });
   }
 }
 
 export function calculateMismatchingVersions(
   dependencyVersions: DependenciesToVersionsSeen
 ): MismatchingDependencyVersions {
-  return [...dependencyVersions.keys()].sort().flatMap((dependency) => {
-    const versionList = dependencyVersions.get(dependency);
-    /* istanbul ignore if */
-    if (!versionList) {
-      // `versionList` should always exist at this point, this if statement is just to please TypeScript.
-      return [];
-    }
+  // Loop through all dependencies seen.
+  return [...dependencyVersions.entries()]
+    .sort()
+    .flatMap(([dependency, versionObjectsForDep]) => {
+      /* istanbul ignore if */
+      if (!versionObjectsForDep) {
+        // Should always exist at this point, this if statement is just to please TypeScript.
+        return [];
+      }
 
-    const uniqueVersions = [
-      ...new Set(versionList.map((object) => object.version)),
-    ].sort();
+      // Calculate unique versions seen for this dependency.
+      const uniqueVersions = [
+        ...new Set(
+          versionObjectsForDep
+            .filter((versionObject) => !versionObject.isLocalPackageVersion)
+            .map((versionObject) => versionObject.version)
+        ),
+      ].sort();
 
-    if (uniqueVersions.length > 1) {
-      const uniqueVersionsWithInfo = uniqueVersions.map((uniqueVersion) => {
-        const matchingVersions = versionList.filter(
-          (object) => object.version === uniqueVersion
+      // If we saw more than one unique version for this dependency, we found an inconsistency.
+      if (uniqueVersions.length > 1) {
+        const uniqueVersionsWithInfo = versionsObjectsWithSortedPackages(
+          uniqueVersions,
+          versionObjectsForDep
         );
-        return {
-          version: uniqueVersion,
-          packages: matchingVersions
-            .map((object) => object.package)
-            .sort(Package.comparator),
-        };
-      });
-      return { dependency, versions: uniqueVersionsWithInfo };
-    }
+        return { dependency, versions: uniqueVersionsWithInfo };
+      }
+
+      // If we saw a local package version that isn't compatible with the local package's actual version, we found an inconsistency.
+      const localPackageVersions = versionObjectsForDep
+        .filter((object) => object.isLocalPackageVersion)
+        .map((object) => object.version);
+      if (
+        localPackageVersions.length === 1 &&
+        uniqueVersions.length === 1 &&
+        !semver.satisfies(localPackageVersions[0], uniqueVersions[0])
+      ) {
+        const uniqueVersionsWithInfo = versionsObjectsWithSortedPackages(
+          [...uniqueVersions, ...localPackageVersions],
+          versionObjectsForDep
+        );
+        return { dependency, versions: uniqueVersionsWithInfo };
+      }
 
-    return [];
+      return [];
+    });
+}
+
+function versionsObjectsWithSortedPackages(
+  versions: string[],
+  versionObjects: {
+    package: Package;
+    version: string;
+    isLocalPackageVersion: boolean;
+  }[]
+) {
+  return versions.map((version) => {
+    const matchingVersionObjects = versionObjects.filter(
+      (versionObject) => versionObject.version === version
+    );
+    return {
+      version,
+      packages: matchingVersionObjects
+        .map((object) => object.package)
+        .sort(Package.comparator),
+    };
   });
 }
 
@@ -255,6 +304,8 @@ export function fixMismatchingVersions(
 
     if (isFixed) {
       fixed.push(mismatchingVersion);
+    } else {
+      notFixed.push(mismatchingVersion);
     }
   }
 

test/fixtures/inconsistent-local-package-version/package.json

@@ -0,0 +1,5 @@
+{
+    "workspaces": [
+        "*"
+    ]
+}

test/fixtures/inconsistent-local-package-version/package1/package.json

@@ -0,0 +1,6 @@
+{
+    "name": "package1",
+    "dependencies": {
+        "package2": "^0.0.0"
+    }
+}

test/fixtures/inconsistent-local-package-version/package2/package.json

@@ -0,0 +1,4 @@
+{
+    "name": "package2",
+    "version": "1.0.0"
+}

test/fixtures/index.ts

@@ -40,3 +40,7 @@ export const FIXTURE_PATH_PACKAGE_MISSING_NAME = join(
   FIXTURE_PATH,
   'package-missing-name'
 );
+export const FIXTURE_PATH_INCONSISTENT_LOCAL_PACKAGE_VERSION = join(
+  FIXTURE_PATH,
+  'inconsistent-local-package-version'
+);

test/fixtures/valid/foo1/package.json

@@ -1,3 +1,4 @@
 {
-    "name": "foo1"
+    "name": "foo1",
+    "version": "1.2.3"
 }

test/fixtures/valid/package1/package.json

@@ -2,6 +2,7 @@
     "name": "package1",
     "dependencies": {
       "foo": "1.2.3",
+      "foo1": "^1.0.0",
       "bar": "^4.5.6"
     },
     "devDependencies": {