fix: allow workspace prefix for local package (#520)

bmish · web-flow · commit 4a005e1cacf7 · 2022-09-06T22:19:34.000-04:00
diff --git a/lib/dependency-versions.ts b/lib/dependency-versions.ts
@@ -154,15 +154,19 @@ export function calculateMismatchingVersions(
       const localPackageVersions = versionObjectsForDep
         .filter((versionObject) => versionObject.isLocalPackageVersion)
         .map((versionObject) => versionObject.version);
-
+      const allVersionsHaveWorkspacePrefix = versions.every((version) =>
+        version.startsWith('workspace:')
+      );
+      const hasIncompatibilityWithLocalPackageVersion = versions.some(
+        (version) => !semver.satisfies(localPackageVersions[0], version)
+      );
       if (
         localPackageVersions.length === 1 &&
-        versions.some(
-          (uniqueVersion) =>
-            !semver.satisfies(localPackageVersions[0], uniqueVersion)
-        )
+        !allVersionsHaveWorkspacePrefix &&
+        hasIncompatibilityWithLocalPackageVersion
       ) {
         // If we saw a version for this dependency that isn't compatible with its actual local package version, add the local package version to the list of versions seen.
+        // Note that using the `workspace:` prefix to refer to the local package version is allowed.
         versions = [...versions, ...localPackageVersions];
       }
 
diff --git a/test/fixtures/all-version-types/package.json b/test/fixtures/all-version-types/package.json
@@ -24,8 +24,11 @@
         "git6": "mochajs/mocha#4727d357ea",
         "git7": "user/repo#feature\/branch",
         "star": "*",
-        "workspace1": "workspace:^",
-        "workspace2": "workspace:*",
+        "workspace1": "workspace:*",
+        "workspace2": "workspace:^",
+        "workspace3": "workspace:~",
+        "workspace4": "workspace:^1.2.3",
+        "workspace5": "workspace:path/to/baz",
         "latest": "latest",
         "//": "some comment",
         "blank": "",
diff --git a/test/fixtures/all-version-types/package1/package.json b/test/fixtures/all-version-types/package1/package.json
@@ -22,8 +22,11 @@
         "git6": "mochajs/mocha#4727d357ea",
         "git7": "user/repo#feature\/branch",
         "star": "*",
-        "workspace1": "workspace:^",
-        "workspace2": "workspace:*",
+        "workspace1": "workspace:*",
+        "workspace2": "workspace:^",
+        "workspace3": "workspace:~",
+        "workspace4": "workspace:^1.2.3",
+        "workspace5": "workspace:path/to/baz",
         "latest": "latest",
         "//": "some comment",
         "blank": "",
diff --git a/test/fixtures/inconsistent-with-workspace-prefix/package.json b/test/fixtures/inconsistent-with-workspace-prefix/package.json
@@ -0,0 +1,8 @@
+{
+    "workspaces": [
+        "*"
+    ],
+    "dependencies": {
+        "package1": "workspace:*"
+    }
+}
diff --git a/test/fixtures/inconsistent-with-workspace-prefix/package1/package.json b/test/fixtures/inconsistent-with-workspace-prefix/package1/package.json
@@ -0,0 +1,4 @@
+{
+    "name": "package1",
+    "version": "1.0.0"
+}
diff --git a/test/fixtures/inconsistent-with-workspace-prefix/package2/package.json b/test/fixtures/inconsistent-with-workspace-prefix/package2/package.json
@@ -0,0 +1,5 @@
+{
+    "dependencies": {
+        "package1": "workspace:^"
+    }
+}
diff --git a/test/fixtures/index.ts b/test/fixtures/index.ts
@@ -66,3 +66,13 @@ export const FIXTURE_PATH_ALL_VERSION_TYPES = join(
   FIXTURE_PATH,
   'all-version-types'
 );
+
+export const FIXTURE_PATH_VALID_WITH_WORKSPACE_PREFIX = join(
+  FIXTURE_PATH,
+  'valid-with-workspace-prefix'
+);
+
+export const FIXTURE_PATH_INCONSISTENT_WITH_WORKSPACE_PREFIX = join(
+  FIXTURE_PATH,
+  'inconsistent-with-workspace-prefix'
+);
diff --git a/test/fixtures/valid-with-workspace-prefix/package.json b/test/fixtures/valid-with-workspace-prefix/package.json
@@ -0,0 +1,8 @@
+{
+    "workspaces": [
+        "*"
+    ],
+    "dependencies": {
+        "package1": "workspace:*"
+    }
+}
diff --git a/test/fixtures/valid-with-workspace-prefix/package1/package.json b/test/fixtures/valid-with-workspace-prefix/package1/package.json
@@ -0,0 +1,4 @@
+{
+    "name": "package1",
+    "version": "1.0.0"
+}
diff --git a/test/fixtures/valid-with-workspace-prefix/package2/package.json b/test/fixtures/valid-with-workspace-prefix/package2/package.json
@@ -0,0 +1,5 @@
+{
+    "dependencies": {
+        "package1": "workspace:*"
+    }
+}
diff --git a/test/lib/dependency-versions-test.ts b/test/lib/dependency-versions-test.ts
@@ -14,6 +14,8 @@ import {
   FIXTURE_PATH_INCONSISTENT_LOCAL_PACKAGE_VERSION,
   FIXTURE_PATH_RESOLUTIONS,
   FIXTURE_PATH_ALL_VERSION_TYPES,
+  FIXTURE_PATH_VALID_WITH_WORKSPACE_PREFIX,
+  FIXTURE_PATH_INCONSISTENT_WITH_WORKSPACE_PREFIX,
 } from '../fixtures/index.js';
 import mockFs from 'mock-fs';
 import { readFileSync } from 'node:fs';
@@ -218,6 +220,47 @@ describe('Utils | dependency-versions', function () {
         []
       );
     });
+
+    it('has no problem with consistent workspace prefixes', function () {
+      const dependencyVersions = calculateVersionsForEachDependency(
+        getPackagesHelper(FIXTURE_PATH_VALID_WITH_WORKSPACE_PREFIX)
+      );
+      expect(calculateMismatchingVersions(dependencyVersions)).toStrictEqual(
+        []
+      );
+    });
+
+    it('has mismatches with inconsistent workspace prefixes', function () {
+      const dependencyVersions = calculateVersionsForEachDependency(
+        getPackagesHelper(FIXTURE_PATH_INCONSISTENT_WITH_WORKSPACE_PREFIX)
+      );
+      expect(calculateMismatchingVersions(dependencyVersions)).toStrictEqual([
+        {
+          dependency: 'package1',
+          versions: [
+            {
+              version: 'workspace:*',
+              packages: [
+                expect.objectContaining({
+                  path: FIXTURE_PATH_INCONSISTENT_WITH_WORKSPACE_PREFIX,
+                }),
+              ],
+            },
+            {
+              version: 'workspace:^',
+              packages: [
+                expect.objectContaining({
+                  path: join(
+                    FIXTURE_PATH_INCONSISTENT_WITH_WORKSPACE_PREFIX,
+                    'package2'
+                  ),
+                }),
+              ],
+            },
+          ],
+        },
+      ]);
+    });
   });
 
   describe('#filterOutIgnoredDependencies', function () {

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +    "name": "package1",
 +    "version": "1.0.0"
 +}