Support 'workspace:^' notation in dependency versions (#125)

cryptodev-2s · web-flow · commit b12e72e6d646 · 2023-12-15T23:43:12.000+01:00
diff --git a/src/package-manifest.test.ts b/src/package-manifest.test.ts
@@ -66,6 +66,7 @@ describe('package-manifest', () => {
             a: '1.0.0',
             b: '^2.0.0',
             c: '~4.3.0',
+            d: 'workspace:^',
           },
         };
         const validated = {
@@ -77,6 +78,7 @@ describe('package-manifest', () => {
             a: '1.0.0',
             b: '^2.0.0',
             c: '~4.3.0',
+            d: 'workspace:^',
           },
           peerDependencies: {},
         };
@@ -100,6 +102,7 @@ describe('package-manifest', () => {
             a: '1.0.0',
             b: '^2.0.0',
             c: '~4.3.0',
+            d: 'workspace:^',
           },
         };
         const validated = {
@@ -112,6 +115,7 @@ describe('package-manifest', () => {
             a: '1.0.0',
             b: '^2.0.0',
             c: '~4.3.0',
+            d: 'workspace:^',
           },
         };
         await fs.promises.writeFile(manifestPath, JSON.stringify(unvalidated));
diff --git a/src/package-manifest.ts b/src/package-manifest.ts
@@ -142,6 +142,24 @@ function isValidPackageManifestVersionField(
   return isTruthyString(version) && semver.validRange(version) !== null;
 }
 
+/**
+ * Type guard to ensure that the provided version value is a valid dependency version
+ * specifier for a package manifest. This function validates both semantic versioning
+ * ranges and the special 'workspace:^' notation.
+ *
+ * @param version - The value to check.
+ * @returns `true` if the version is a valid string that either
+ * represents a semantic versioning range or is exactly 'workspace:^'.
+ * Otherwise, it returns `false`.
+ */
+function isValidPackageManifestDependencyValue(
+  version: unknown,
+): version is string {
+  return (
+    isValidPackageManifestVersionField(version) || version === 'workspace:^'
+  );
+}
+
 /**
  * Retrieves and validates the "version" field within the package manifest
  * object.
@@ -285,7 +303,8 @@ function isValidPackageManifestDependenciesField(
     (isPlainObject(depsValue) &&
       Object.entries(depsValue).every(([pkgName, version]) => {
         return (
-          isTruthyString(pkgName) && isValidPackageManifestVersionField(version)
+          isTruthyString(pkgName) &&
+          isValidPackageManifestDependencyValue(version)
         );
       }))
   );
