synopkg 14.0.1

Consistent dependency versions in large JavaScript Monorepos
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

use {
  super::indent::{L1, L2, L3, L4, L5, L6, L7, L8},
  crate::instance_state::{FixableInstance, SuspectInstance, ValidInstance},
  log::debug,
};

#[cfg(test)]
#[path = "pinned_test.rs"]
mod pinned_test;

pub fn visit(dependency: &crate::dependency::Dependency) {
  debug!("visit pinned version group");
  debug!("{L1}visit dependency '{}'", dependency.internal_name);
  let pinned_specifier = dependency.pinned_specifier.clone().unwrap();
  dependency.set_expected_specifier(&pinned_specifier);
  dependency.instances.iter().for_each(|instance| {
    let actual_specifier = &instance.descriptor.specifier;
    debug!("{L2}visit instance '{}' ({actual_specifier:?})", instance.id);
    if instance.is_local {
      debug!("{L3}it is the local instance of a package developed locally in this monorepo");
      debug!("{L4}refuse to change it");
      debug!("{L5}mark as error, user should change their config");
      instance.mark_suspect(SuspectInstance::RefuseToPinLocal);
      return;
    }
    if instance.already_equals(&pinned_specifier) {
      debug!("{L3}it is identical to the pinned version");
      debug!("{L4}mark as valid");
      instance.mark_valid(ValidInstance::IsIdenticalToPin, &pinned_specifier);
      return;
    }
    debug!("{L3}it depends on the local instance");
    debug!("{L4}its version number (without a range):");
    if !instance.descriptor.specifier.has_same_version_number_as(&pinned_specifier) {
      debug!("{L5}differs to the pinned version");
      debug!("{L6}mark as error");
      instance.mark_fixable(FixableInstance::DiffersToPin, &pinned_specifier);
      return;
    }
    debug!("{L5}is the same as the pinned version");
    if instance.must_match_preferred_semver_range_which_differs_to(&pinned_specifier) {
      let preferred_semver_range = &instance.preferred_semver_range.clone().unwrap();
      debug!("{L6}it is in a semver group which prefers a different semver range to the pinned version ({preferred_semver_range:?})");
      if instance.matches_preferred_semver_range() {
        debug!("{L7}its semver range matches its semver group");
        debug!("{L8}1. pin it and ignore the semver group");
        debug!("{L8}2. mark as suspect (the config is asking for a different range AND they want to pin it)");
        instance.mark_fixable(FixableInstance::PinOverridesSemverRange, &pinned_specifier);
      } else {
        debug!("{L7}its semver range does not match its semver group or the pinned version's");
        debug!("{L8}1. pin it and ignore the semver group");
        debug!("{L8}2. mark as suspect (the config is asking for a different range AND they want to pin it)");
        instance.mark_fixable(FixableInstance::PinOverridesSemverRangeMismatch, &pinned_specifier);
      }
      return;
    }
    debug!("{L6}it is not in a semver group which prefers a different semver range to the pinned version");
    debug!("{L7}it differs to the pinned version");
    debug!("{L8}mark as error");
    instance.mark_fixable(FixableInstance::DiffersToPin, &pinned_specifier);
  });
}