feat(align-deps): allow version range subsets

.changeset/quiet-houses-tap.md

@@ -0,0 +1,6 @@
+---
+"@rnx-kit/align-deps": minor
+"@rnx-kit/cli": patch
+---
+
+Allow exact and version range subsets with `--diff-mode allow-subset`

packages/align-deps/src/cli.ts

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-import { error } from "@rnx-kit/console";
+import { error, warn } from "@rnx-kit/console";
 import { hasProperty } from "@rnx-kit/tools-language/properties";
 import { findPackageDir } from "@rnx-kit/tools-node/package";
 import {
@@ -15,9 +15,15 @@ import { makeSetVersionCommand } from "./commands/setVersion";
 import { defaultConfig } from "./config";
 import { printError, printInfo } from "./errors";
 import { isString } from "./helpers";
-import type { Args, Command } from "./types";
+import type { Args, Command, DiffMode } from "./types";
 
 export const cliOptions = {
+  "diff-mode": {
+    default: "strict",
+    description:
+      "Determines what align-deps should do when versions differ. Valid values are 'strict' (version strings must be equal) and 'allow-subset' (allow version ranges that are a subset).",
+    choices: ["strict", "allow-subset"],
+  },
   "exclude-packages": {
     description:
       "Comma-separated list of package names to exclude from inspection.",
@@ -148,6 +154,19 @@ function reportConflicts(conflicts: [string, string][], args: Args): boolean {
   }, false);
 }
 
+function validateDiffMode(mode: string | undefined): DiffMode {
+  switch (mode) {
+    case "allow-subset":
+    case "strict":
+      return mode;
+    default:
+      if (mode) {
+        warn("Unknown diff mode:", mode);
+      }
+      return "strict";
+  }
+}
+
 async function makeCommand(args: Args): Promise<Command | undefined> {
   const conflicts: [string, string][] = [
     ["init", "set-version"],
@@ -159,6 +178,7 @@ async function makeCommand(args: Args): Promise<Command | undefined> {
   }
 
   const {
+    "diff-mode": diffMode,
     "exclude-packages": excludePackages,
     init,
     loose,
@@ -178,6 +198,7 @@ async function makeCommand(args: Args): Promise<Command | undefined> {
     noUnmanaged,
     verbose,
     write,
+    diffMode: validateDiffMode(diffMode),
     excludePackages: excludePackages?.toString()?.split(","),
     requirements: requirements?.toString()?.split(","),
   };

packages/align-deps/src/commands/check.ts

@@ -84,7 +84,7 @@ export function checkPackageManifest(
     kitType
   );
 
-  const allChanges = diff(manifest, updatedManifest);
+  const allChanges = diff(manifest, updatedManifest, options);
   if (allChanges) {
     if (options.write) {
       // The config object may be passed to other commands, so we need to

packages/align-deps/src/diff.ts

@@ -1,10 +1,16 @@
 import type { PackageManifest } from "@rnx-kit/tools-node/package";
+import semverRangeSubset from "semver/ranges/subset";
 import { dependencySections } from "./helpers";
-import type { Changes } from "./types";
+import type { Changes, Options } from "./types";
+
+function isStrictlyEqual(version: string, range: string) {
+  return version === range;
+}
 
 export function diff(
   manifest: PackageManifest,
-  updatedManifest: PackageManifest
+  updatedManifest: PackageManifest,
+  { diffMode }: Pick<Options, "diffMode">
 ): Changes | undefined {
   const allChanges: Changes = {
     dependencies: [],
@@ -13,6 +19,9 @@ export function diff(
     capabilities: [],
   };
 
+  const satisfies =
+    diffMode === "allow-subset" ? semverRangeSubset : isStrictlyEqual;
+
   const numChanges = dependencySections.reduce((count, section) => {
     const changes = allChanges[section];
     const currentDeps = manifest[section] ?? {};
@@ -22,7 +31,7 @@ export function diff(
       const current = currentDeps[dependency];
       if (!current) {
         changes.push({ type: "added", dependency, target });
-      } else if (current !== target) {
+      } else if (!satisfies(current, target)) {
         changes.push({ type: "changed", dependency, target, current });
       }
     }

packages/align-deps/src/types.ts

@@ -19,18 +19,22 @@ export type Changes = {
   capabilities: { type: "unmanaged"; dependency: string; capability: string }[];
 };
 
+export type DiffMode = "strict" | "allow-subset";
+
 export type Options = {
   presets: string[];
   loose: boolean;
   migrateConfig: boolean;
   noUnmanaged: boolean;
   verbose: boolean;
   write: boolean;
+  diffMode?: DiffMode;
   excludePackages?: string[];
   requirements?: string[];
 };
 
 export type Args = Pick<Options, "loose" | "verbose" | "write"> & {
+  "diff-mode"?: string;
   "exclude-packages"?: string | number;
   "migrate-config": boolean;
   "no-unmanaged": boolean;

packages/align-deps/test/check.test.ts

@@ -401,6 +401,77 @@ describe("checkPackageManifest({ kitType: 'library' })", () => {
     expect(consoleWarnSpy).not.toHaveBeenCalled();
     expect(consoleErrorSpy).not.toHaveBeenCalled();
   });
+
+  test("allows exact versions", () => {
+    const mods = /^[^\d]*/;
+    fs.__setMockContent({
+      ...mockManifest,
+      peerDependencies: {
+        react: react_v68_v69_v70,
+        "react-native": v68_v69_v70,
+      },
+      devDependencies: {
+        react: packageVersion(profile_0_69, "react").replace(mods, ""),
+        "react-native": packageVersion(profile_0_69, "core").replace(mods, ""),
+      },
+    });
+    rnxKitConfig.__setMockConfig({
+      alignDeps: {
+        requirements: {
+          development: ["react-native@0.69"],
+          production: ["react-native@0.68 || 0.69 || 0.70"],
+        },
+        capabilities: ["core-ios"],
+      },
+    });
+
+    const result = checkPackageManifest("package.json", {
+      ...defaultOptions,
+      diffMode: "allow-subset",
+    });
+
+    expect(result).toBe("success");
+    expect(consoleLogSpy).not.toHaveBeenCalled();
+    expect(consoleWarnSpy).not.toHaveBeenCalled();
+    expect(consoleErrorSpy).not.toHaveBeenCalled();
+  });
+
+  test("allows version range subsets", () => {
+    const patch = /\.\d*$/;
+    fs.__setMockContent({
+      ...mockManifest,
+      peerDependencies: {
+        react: react_v68_v69_v70,
+        "react-native": v68_v69_v70,
+      },
+      devDependencies: {
+        react: packageVersion(profile_0_69, "react"),
+        "react-native": packageVersion(profile_0_69, "core").replace(
+          patch,
+          ".9999"
+        ),
+      },
+    });
+    rnxKitConfig.__setMockConfig({
+      alignDeps: {
+        requirements: {
+          development: ["react-native@0.69"],
+          production: ["react-native@0.68 || 0.69 || 0.70"],
+        },
+        capabilities: ["core-ios"],
+      },
+    });
+
+    const result = checkPackageManifest("package.json", {
+      ...defaultOptions,
+      diffMode: "allow-subset",
+    });
+
+    expect(result).toBe("success");
+    expect(consoleLogSpy).not.toHaveBeenCalled();
+    expect(consoleWarnSpy).not.toHaveBeenCalled();
+    expect(consoleErrorSpy).not.toHaveBeenCalled();
+  });
 });
 
 describe("checkPackageManifest({ kitType: 'library' }) (backwards compatibility)", () => {

packages/cli/src/align-deps.ts

@@ -19,6 +19,7 @@ export function rnxAlignDeps(
 ): void {
   cli({
     ...pickValues(args, Object.values(optionsMap), Object.keys(optionsMap)),
+    "diff-mode": args.diffMode?.toString(),
     loose: Boolean(args.loose),
     "migrate-config": Boolean(args.migrateConfig),
     "no-unmanaged": Boolean(args.noUnmanaged),
@@ -34,6 +35,10 @@ export const rnxAlignDepsCommand = {
     "Manage dependencies within a repository and across many repositories",
   func: rnxAlignDeps,
   options: [
+    {
+      name: `--diff-mode [${cliOptions["diff-mode"].choices.join("|")}]`,
+      description: cliOptions["diff-mode"].description,
+    },
     {
       name: "--exclude-packages [packages]",
       description: cliOptions["exclude-packages"].description,