feat(pnpm): consider workspace protocol valid by default

Closes #252

Author: JamieMason

src/rcfile.rs

@@ -24,6 +24,10 @@ fn default_true() -> bool {
   true
 }
 
+fn default_false() -> bool {
+  false
+}
+
 fn default_indent() -> String {
   "  ".to_string()
 }
@@ -118,6 +122,8 @@ pub struct Rcfile {
   pub sort_packages: bool,
   #[serde(default = "default_source")]
   pub source: Vec<String>,
+  #[serde(default = "default_false")]
+  pub strict: bool,
   #[serde(default)]
   pub version_groups: Vec<AnyVersionGroup>,
 }
@@ -137,6 +143,7 @@ impl Rcfile {
       sort_first: sort_first(),
       sort_packages: default_true(),
       source: default_source(),
+      strict: default_false(),
       version_groups: vec![],
     }
   }

src/visit_packages.rs

@@ -9,7 +9,7 @@ use {
     format,
     instance_state::{FixableInstance::*, SemverGroupAndVersionConflict::*, SuspectInstance::*, UnfixableInstance::*, ValidInstance::*},
     package_json::{FormatMismatch, FormatMismatchVariant::*, PackageJson},
-    specifier::{semver_range::SemverRange, Specifier},
+    specifier::{non_semver::NonSemver, semver_range::SemverRange, Specifier},
     version_group::VersionGroupVariant,
   },
   itertools::Itertools,
@@ -89,6 +89,18 @@ pub fn visit_packages(ctx: Context) -> Context {
                   return;
                 }
                 debug!("        it depends on the local instance");
+                if matches!(instance.actual_specifier, Specifier::NonSemver(NonSemver::WorkspaceProtocol(_))) {
+                  debug!("          it is using the workspace protocol");
+                  if !ctx.config.rcfile.strict {
+                    debug!("            strict mode is off");
+                    debug!("              mark as satisfying local");
+                    instance.mark_valid(SatisfiesLocal, &instance.actual_specifier);
+                    return;
+                  }
+                  debug!("            strict mode is on");
+                } else {
+                  debug!("          it is not using the workspace protocol");
+                }
                 debug!("          its version number (without a range):");
                 if !instance.actual_specifier.has_same_version_number_as(&local_specifier) {
                   debug!("            differs to the local instance");

src/visit_packages_test.rs

@@ -1292,6 +1292,72 @@ fn no_instances_are_semver_and_they_differ() {
   ]);
 }
 
+#[test]
+fn workspace_protocol_version_differs_to_local_version_is_invalid_in_strict_mode() {
+  let config = test::mock::config_from_mock(json!({
+    "strict": true
+  }));
+  let packages = test::mock::packages_from_mocks(vec![json!({
+    "name": "package-a",
+    "version": "1.0.0",
+    "devDependencies": {
+      "package-a": "workspace:*"
+    }
+  })]);
+  let ctx = Context::create(config, packages);
+  let ctx = visit_packages(ctx);
+  expect(&ctx).to_have_instances(vec![
+    ExpectedInstance {
+      state: InstanceState::valid(IsLocalAndValid),
+      dependency_name: "package-a",
+      id: "package-a in /version of package-a",
+      actual: "1.0.0",
+      expected: Some("1.0.0"),
+      overridden: None,
+    },
+    ExpectedInstance {
+      state: InstanceState::fixable(DiffersToLocal),
+      dependency_name: "package-a",
+      id: "package-a in /devDependencies of package-a",
+      actual: "workspace:*",
+      expected: Some("1.0.0"),
+      overridden: None,
+    },
+  ]);
+}
+
+#[test]
+fn workspace_protocol_version_differs_to_local_version_is_valid_by_default() {
+  let config = test::mock::config_from_mock(json!({}));
+  let packages = test::mock::packages_from_mocks(vec![json!({
+    "name": "package-a",
+    "version": "1.0.0",
+    "devDependencies": {
+      "package-a": "workspace:*"
+    }
+  })]);
+  let ctx = Context::create(config, packages);
+  let ctx = visit_packages(ctx);
+  expect(&ctx).to_have_instances(vec![
+    ExpectedInstance {
+      state: InstanceState::valid(IsLocalAndValid),
+      dependency_name: "package-a",
+      id: "package-a in /version of package-a",
+      actual: "1.0.0",
+      expected: Some("1.0.0"),
+      overridden: None,
+    },
+    ExpectedInstance {
+      state: InstanceState::valid(SatisfiesLocal),
+      dependency_name: "package-a",
+      id: "package-a in /devDependencies of package-a",
+      actual: "workspace:*",
+      expected: Some("workspace:*"),
+      overridden: None,
+    },
+  ]);
+}
+
 // = Ignored Version Group =====================================================
 
 #[test]