feat(align-deps) allow exact version within range according to semver…

…Satisfies
microsoft · Mar 25, 2024 · b424f3e · b424f3e
1 parent ebb2c54
commit b424f3e
Show file tree

Hide file tree

Showing 8 changed files with 28 additions and 3 deletions.
diff --git a/packages/align-deps/src/cli.ts b/packages/align-deps/src/cli.ts
@@ -76,6 +76,12 @@ export const cliOptions = {
     description: "Writes changes to the specified 'package.json'.",
     type: "boolean",
   },
+  "diff-mode": {
+    default: "strict",
+    description:
+      "Determines the diff mode that align-deps uses to check version declarations in 'package.json'. Valid values are 'strict', meaning only strict equality with capability requirements (usually a range) are allowed and 'allow-exact-version' which allows versions that are within the required range, making it possible to declare exact versions.",
+    choices: ["strict", "allow-exact-version"],
+  },
 };
 
 async function getManifests(
@@ -169,6 +175,7 @@ async function makeCommand(args: Args): Promise<Command | undefined> {
     "set-version": setVersion,
     verbose,
     write,
+    "diff-mode": diffMode,
   } = args;
 
   const options = {
@@ -180,6 +187,7 @@ async function makeCommand(args: Args): Promise<Command | undefined> {
     write,
     excludePackages: excludePackages?.toString()?.split(","),
     requirements: requirements?.toString()?.split(","),
+    diffMode,
   };
 
   if (typeof init !== "undefined") {

diff --git a/packages/align-deps/src/commands/check.ts b/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.diffMode);
   if (allChanges) {
     if (options.write) {
       // The config object may be passed to other commands, so we need to

diff --git a/packages/align-deps/src/diff.ts b/packages/align-deps/src/diff.ts
@@ -1,17 +1,22 @@
 import { keysOf } from "@rnx-kit/tools-language";
 import type { PackageManifest } from "@rnx-kit/tools-node/package";
+import semverSatisfies from "semver/functions/satisfies";
 import type { Changes } from "./types";
 
+export type DiffMode = "strict" | "allow-exact-version";
+
 export function diff(
   manifest: PackageManifest,
-  updatedManifest: PackageManifest
+  updatedManifest: PackageManifest,
+  mode: DiffMode = "strict"
 ): Changes | undefined {
   const allChanges: Changes = {
     dependencies: [],
     peerDependencies: [],
     devDependencies: [],
   };
 
+  const allowExactVersion = mode === "allow-exact-version";
   const numChanges = keysOf(allChanges).reduce((count, section) => {
     const changes = allChanges[section];
     const currentDeps = manifest[section] ?? {};
@@ -22,7 +27,9 @@ export function diff(
       if (!current) {
         changes.push({ type: "added", dependency, target });
       } else if (current !== target) {
-        changes.push({ type: "changed", dependency, target, current });
+        if (!allowExactVersion || !semverSatisfies(current, target)) {
+          changes.push({ type: "changed", dependency, target, current });
+        }
       }
     }
 

diff --git a/packages/align-deps/src/types.ts b/packages/align-deps/src/types.ts
@@ -27,6 +27,7 @@ export type Options = {
   write: boolean;
   excludePackages?: string[];
   requirements?: string[];
+  diffMode?: string;
 };
 
 export type Args = Pick<Options, "loose" | "verbose" | "write"> & {
@@ -38,6 +39,7 @@ export type Args = Pick<Options, "loose" | "verbose" | "write"> & {
   packages?: (string | number)[];
   presets?: string | number;
   requirements?: string | number;
+  "diff-mode"?: string;
 };
 
 export type DependencyType = "direct" | "development" | "peer";

diff --git a/packages/align-deps/test/initialize.test.ts b/packages/align-deps/test/initialize.test.ts
@@ -11,6 +11,7 @@ const defaultOptions = {
   noUnmanaged: false,
   verbose: false,
   write: false,
+  diffMode: "strict",
 };
 
 describe("initializeConfig()", () => {

diff --git a/packages/align-deps/test/setVersion.test.ts b/packages/align-deps/test/setVersion.test.ts
@@ -38,6 +38,7 @@ describe("makeSetVersionCommand()", () => {
     noUnmanaged: false,
     verbose: false,
     write: false,
+    diffMode: "strict",
   };
 
   afterEach(() => {

diff --git a/packages/align-deps/test/vigilant.test.ts b/packages/align-deps/test/vigilant.test.ts
@@ -301,6 +301,7 @@ describe("checkPackageManifestUnconfigured()", () => {
     noUnmanaged: false,
     verbose: false,
     write: false,
+    diffMode: "strict",
   };
 
   beforeEach(() => {

diff --git a/packages/cli/src/align-deps.ts b/packages/cli/src/align-deps.ts
@@ -25,6 +25,7 @@ export function rnxAlignDeps(
     verbose: Boolean(args.verbose),
     write: Boolean(args.write),
     packages: argv,
+    "allow-exact-version": Boolean(args.allowExactVersion),
   });
 }
 
@@ -74,5 +75,9 @@ export const rnxAlignDepsCommand = {
       name: "--write",
       description: cliOptions.write.description,
     },
+    {
+      name: `--diff-mode [${cliOptions["diff-mode"].choices?.join("|")}]`,
+      description: cliOptions["diff-mode"].description,
+    },
   ],
 };