feat(groups): allow many deps to be treated as one

Closes #204

Author: JamieMason

fixtures/fluid-framework/.syncpackrc.json

@@ -4,6 +4,12 @@
     "engines": { "path": "engines", "strategy": "versionsByName" },
     "packageManager": { "path": "packageManager", "strategy": "name@version" }
   },
+  "aliases": [
+    {
+      "label": "prosemirror-*",
+      "dependencies": ["prosemirror-*"]
+    }
+  ],
   "semverGroups": [
     {
       "label": "Version compatibility workarounds should be used, or removed from syncpack.config.cjs if no longer needed.",

npm/syncpack.ts

@@ -1,6 +1,8 @@
 export interface RcFile {
   /** @see https://jamiemason.github.io/syncpack/integrations/json-schema */
   $schema?: string;
+  /** @see https://jamiemason.github.io/syncpack/config/aliases */
+  aliases?: AliasGroup[];
   /** @see https://jamiemason.github.io/syncpack/config/custom-types */
   customTypes?: Record<string, CustomType.Any>;
   /** @see https://jamiemason.github.io/syncpack/config/format-bugs */
@@ -38,6 +40,19 @@ export interface RcFile {
   specifierTypes?: never;
 }
 
+export interface AliasGroup {
+  /** @see https://jamiemason.github.io/syncpack/config/aliases/#dependencies */
+  dependencies?: string[];
+  /** @see https://jamiemason.github.io/syncpack/config/aliases/#dependencytypes */
+  dependencyTypes?: DependencyType[];
+  /** @see https://jamiemason.github.io/syncpack/config/aliases/#label */
+  label?: string;
+  /** @see https://jamiemason.github.io/syncpack/config/aliases/#packages */
+  packages?: string[];
+  /** @see https://jamiemason.github.io/syncpack/config/aliases/#specifiertypes */
+  specifierTypes?: SpecifierType[];
+}
+
 export interface DependencyGroup {
   /** @see https://jamiemason.github.io/syncpack/config/version-groups/standard/#dependencies */
   dependencies?: string[];
@@ -82,11 +97,11 @@ namespace VersionGroup {
   }
   export interface SameRange extends DependencyGroup {
     /** @see https://jamiemason.github.io/syncpack/config/version-groups/same-range/#policy */
-    policy: "sameRange";
+    policy: 'sameRange';
   }
   export interface Standard extends DependencyGroup {
     /** @see https://jamiemason.github.io/syncpack/config/version-groups/lowest-version/#preferversion */
-    preferVersion?: "highestSemver" | "lowestSemver";
+    preferVersion?: 'highestSemver' | 'lowestSemver';
   }
   export type Any =
     | Banned
@@ -104,25 +119,25 @@ namespace CustomType {
     /** @see https://jamiemason.github.io/syncpack/config/custom-types/#name */
     path: string;
     /** @see https://jamiemason.github.io/syncpack/config/custom-types/#namestrategy */
-    strategy: "name~version";
+    strategy: 'name~version';
   }
   export interface NamedVersionString {
     /** @see https://jamiemason.github.io/syncpack/config/custom-types/#name */
     path: string;
     /** @see https://jamiemason.github.io/syncpack/config/custom-types/#namestrategy */
-    strategy: "name@version";
+    strategy: 'name@version';
   }
   export interface UnnamedVersionString {
     /** @see https://jamiemason.github.io/syncpack/config/custom-types/#name */
     path: string;
     /** @see https://jamiemason.github.io/syncpack/config/custom-types/#namestrategy */
-    strategy: "version";
+    strategy: 'version';
   }
   export interface VersionsByName {
     /** @see https://jamiemason.github.io/syncpack/config/custom-types/#name */
     path: string;
     /** @see https://jamiemason.github.io/syncpack/config/custom-types/#namestrategy */
-    strategy: "versionsByName";
+    strategy: 'versionsByName';
   }
   export type Any =
     | NameAndVersionProps
@@ -131,35 +146,35 @@ namespace CustomType {
     | VersionsByName;
 }
 
-type SemverRange = "" | "*" | ">" | ">=" | ".x" | "<" | "<=" | "^" | "~";
+type SemverRange = '' | '*' | '>' | '>=' | '.x' | '<' | '<=' | '^' | '~';
 
 type DependencyType =
-  | "dev"
-  | "local"
-  | "overrides"
-  | "peer"
-  | "pnpmOverrides"
-  | "prod"
-  | "resolutions"
+  | 'dev'
+  | 'local'
+  | 'overrides'
+  | 'peer'
+  | 'pnpmOverrides'
+  | 'prod'
+  | 'resolutions'
   | AnyString;
 
 type SpecifierType =
-  | "alias"
-  | "exact"
-  | "file"
-  | "git"
-  | "latest"
-  | "major"
-  | "minor"
-  | "missing"
-  | "range"
-  | "range-complex"
-  | "range-major"
-  | "range-minor"
-  | "tag"
-  | "unsupported"
-  | "url"
-  | "workspace-protocol"
+  | 'alias'
+  | 'exact'
+  | 'file'
+  | 'git'
+  | 'latest'
+  | 'major'
+  | 'minor'
+  | 'missing'
+  | 'range'
+  | 'range-complex'
+  | 'range-major'
+  | 'range-minor'
+  | 'tag'
+  | 'unsupported'
+  | 'url'
+  | 'workspace-protocol'
   | AnyString;
 
 type AnyString = string & {};

src/cli.rs

@@ -1,5 +1,5 @@
 use {
-  crate::group_selector::GroupSelector,
+  crate::{group_selector::GroupSelector, packages::Packages},
   clap::{builder::ValueParser, crate_description, crate_name, crate_version, Arg, ArgMatches, Command},
   color_print::cformat,
   itertools::Itertools,
@@ -305,12 +305,20 @@ fn get_filters(matches: &ArgMatches) -> Option<GroupSelector> {
   let dependencies = get_patterns(matches, "dependencies");
   let dependency_types = get_patterns(matches, "dependency-types");
   let label = "CLI filters".to_string();
+  let all_packages = &Packages::new();
   let packages = get_patterns(matches, "packages");
   let specifier_types = get_patterns(matches, "specifier-types");
   if dependencies.is_empty() && dependency_types.is_empty() && packages.is_empty() && specifier_types.is_empty() {
     None
   } else {
-    Some(GroupSelector::new(dependencies, dependency_types, label, packages, specifier_types))
+    Some(GroupSelector::new(
+      all_packages,
+      dependencies,
+      dependency_types,
+      label,
+      packages,
+      specifier_types,
+    ))
   }
 }
 

src/context.rs

@@ -28,12 +28,16 @@ pub struct Context {
 impl Context {
   pub fn create(config: Config, packages: Packages) -> Self {
     let mut instances = vec![];
-    let semver_groups = config.rcfile.get_semver_groups();
+    let aliases = config.rcfile.get_aliases(&packages);
+    let semver_groups = config.rcfile.get_semver_groups(&packages);
     let version_groups = config.rcfile.get_version_groups(&packages);
 
     packages.get_all_instances(&config, |instance| {
       let instance = Rc::new(instance);
       instances.push(Rc::clone(&instance));
+      if let Some(alias) = aliases.iter().find(|alias| alias.can_add(&instance)) {
+        instance.set_alias(&alias.label);
+      }
       if let Some(semver_group) = semver_groups.iter().find(|semver_group| semver_group.selector.can_add(&instance)) {
         instance.set_semver_group(semver_group);
       }

src/dependency.rs

@@ -28,7 +28,7 @@ pub struct Dependency {
   /// Does every instance match the filter options provided via the CLI?
   pub matches_cli_filter: RefCell<bool>,
   /// The name of the dependency
-  pub name: String,
+  pub name_internal: String,
   /// The version to pin all instances to when variant is `Pinned`
   pub pinned_specifier: Option<Specifier>,
   /// package.json files developed in the monorepo when variant is `SnappedTo`
@@ -39,7 +39,7 @@ pub struct Dependency {
 
 impl Dependency {
   pub fn new(
-    name: String,
+    name_internal: String,
     variant: VersionGroupVariant,
     pinned_specifier: Option<Specifier>,
     snapped_to_packages: Option<Vec<Rc<RefCell<PackageJson>>>>,
@@ -49,7 +49,7 @@ impl Dependency {
       instances: RefCell::new(vec![]),
       local_instance: RefCell::new(None),
       matches_cli_filter: RefCell::new(false),
-      name,
+      name_internal,
       pinned_specifier,
       snapped_to_packages,
       variant,
@@ -175,7 +175,7 @@ impl Dependency {
   pub fn get_snapped_to_specifier(&self, every_instance_in_the_project: &[Rc<Instance>]) -> Option<Specifier> {
     if let Some(snapped_to_packages) = &self.snapped_to_packages {
       for instance in every_instance_in_the_project {
-        if instance.name == *self.name {
+        if *instance.name_internal.borrow() == *self.name_internal {
           for snapped_to_package in snapped_to_packages {
             if instance.package.borrow().get_name_unsafe() == snapped_to_package.borrow().get_name_unsafe() {
               return Some(instance.actual_specifier.clone());

src/effects/fix.rs

@@ -24,7 +24,7 @@ pub fn run(ctx: Context) -> Context {
     let mut suspect = 0;
 
     ctx.instances.iter().for_each(|instance| {
-      let name = &instance.name;
+      let name_internal = &instance.name_internal.borrow();
 
       if has_cli_filter && !*instance.matches_cli_filter.borrow() {
         return;
@@ -50,14 +50,14 @@ pub fn run(ctx: Context) -> Context {
                 let actual = instance.actual_specifier.unwrap().red();
                 let arrow = ui.dim_right_arrow();
                 let expected = instance.expected_specifier.borrow().as_ref().unwrap().unwrap().green();
-                info!("{name} {actual} {arrow} {expected} {location} {state_link}");
+                info!("{name_internal} {actual} {arrow} {expected} {location} {state_link}");
                 instance.package.borrow().copy_expected_specifier(instance);
               }
             }
           }
           InvalidInstance::Conflict(_) | InvalidInstance::Unfixable(_) => {
             unfixable += 1;
-            warn!("Unfixable: {name} {location} {state_link}");
+            warn!("Unfixable: {name_internal} {location} {state_link}");
           }
         },
         InstanceState::Suspect(variant) => match variant {
@@ -66,7 +66,7 @@ pub fn run(ctx: Context) -> Context {
           | SuspectInstance::RefuseToSnapLocal
           | SuspectInstance::InvalidLocalVersion => {
             suspect += 1;
-            warn!("Suspect: {name} {location} {state_link}");
+            warn!("Suspect: {name_internal} {location} {state_link}");
           }
         },
       }

src/effects/ui.rs

@@ -68,7 +68,7 @@ impl Ui<'_> {
     };
     let instances_len = dependency.instances.borrow().len();
     let count = self.count_column(instances_len);
-    let name = &dependency.name;
+    let name = &dependency.name_internal;
     let name = if self.ctx.config.cli.show_hints && dependency.local_instance.borrow().is_some() {
       let local_hint = "(local)".blue();
       format!("{name} {local_hint}").normal()

src/group_selector.rs

@@ -1,5 +1,5 @@
 use {
-  crate::instance::Instance,
+  crate::{instance::Instance, packages::Packages},
   globset::{Glob, GlobMatcher},
 };
 
@@ -49,12 +49,14 @@ pub struct GroupSelector {
 
 impl GroupSelector {
   pub fn new(
+    all_packages: &Packages,
     dependencies: Vec<String>,
     dependency_types: Vec<String>,
     label: String,
     packages: Vec<String>,
     specifier_types: Vec<String>,
   ) -> GroupSelector {
+    let dependencies = with_resolved_keywords(&dependencies, all_packages);
     GroupSelector {
       include_dependencies: create_globs(true, &dependencies),
       exclude_dependencies: create_globs(false, &dependencies),
@@ -92,7 +94,11 @@ impl GroupSelector {
   }
 
   pub fn matches_dependencies(&self, instance: &Instance) -> bool {
-    matches_globs(&instance.name, &self.include_dependencies, &self.exclude_dependencies)
+    matches_globs(
+      &instance.name_internal.borrow(),
+      &self.include_dependencies,
+      &self.exclude_dependencies,
+    )
   }
 
   pub fn matches_specifier_types(&self, instance: &Instance) -> bool {
@@ -144,3 +150,28 @@ fn matches_identifiers(name: &str, includes: &[String], excludes: &[String]) ->
 fn matches_any_identifier(value: &str, identifiers: &[String]) -> bool {
   identifiers.contains(&value.to_string())
 }
+
+/// Resolve keywords such as `$LOCAL` and `!$LOCAL` to their actual values.
+fn with_resolved_keywords(dependency_names: &[String], packages: &Packages) -> Vec<String> {
+  let mut resolved_dependencies: Vec<String> = vec![];
+  for dependency_name in dependency_names.iter() {
+    match dependency_name.as_str() {
+      "$LOCAL" => {
+        for package in packages.all.iter() {
+          let package_name = package.borrow().get_name_unsafe();
+          resolved_dependencies.push(package_name);
+        }
+      }
+      "!$LOCAL" => {
+        for package in packages.all.iter() {
+          let package_name = package.borrow().get_name_unsafe();
+          resolved_dependencies.push(format!("!{}", package_name));
+        }
+      }
+      _ => {
+        resolved_dependencies.push(dependency_name.clone());
+      }
+    }
+  }
+  resolved_dependencies
+}

src/instance.rs

@@ -36,6 +36,11 @@ pub struct Instance {
   pub matches_cli_filter: RefCell<bool>,
   /// The dependency name eg. "react", "react-dom"
   pub name: String,
+  /// When an alias is used, that is used here in place of the actual name, eg.
+  /// "@aws-sdk/core" -> "all-aws-sdk-packages". Otherwise the actual name is
+  /// used, this aliased name is only used when allocating `Instance`s to
+  /// `Dependency`s, the original name is otherwise preserved.
+  pub name_internal: RefCell<String>,
   /// The `.name` of the package.json this file is in
   pub package: Rc<RefCell<PackageJson>>,
   /// If this instance belongs to a `WithRange` semver group, this is the range.
@@ -65,7 +70,8 @@ impl Instance {
       id: format!("{} in {} of {}", name, &dependency_type.path, package_name),
       is_local: dependency_type.path == "/version",
       matches_cli_filter: RefCell::new(false),
-      name,
+      name: name.clone(),
+      name_internal: RefCell::new(name.clone()),
       package: Rc::clone(&package),
       preferred_semver_range: RefCell::new(None),
       state: RefCell::new(InstanceState::Unknown),
@@ -109,6 +115,11 @@ impl Instance {
     self.set_state(InstanceState::Invalid(InvalidInstance::Unfixable(state)), &self.actual_specifier)
   }
 
+  /// If this instance should use an alias, store it
+  pub fn set_alias(&self, alias: &str) {
+    *self.name_internal.borrow_mut() = alias.to_string();
+  }
+
   /// If this instance should use a preferred semver range, store it
   pub fn set_semver_group(&self, group: &SemverGroup) {
     if let Some(range) = &group.range {