[rush-lib] Add pnpm global catalog detection to rush change by CarltonHowell · Pull Request #5627 · microsoft/rushstack

CarltonHowell · 2026-02-17T18:48:31Z

Summary

Addresses: [rush] rush change does not detect change to catalog version of dependency #5624
rush change does not consider changes to pnpm global catalog changes. Running rush change now considers any chances to catalog entries, be it additions of version changes.

Details

Added catalog change detection logic in getChangedProjectsAsync() between the per-project file change detection and the includeExternalDependencies block. The new logic:
a. Guards on rushConfiguration.isPnpm and globalCatalogs existing
b. Computes the relative path to pnpm-config.json and checks if it's in changedFiles
c. Loads the old pnpm-config.json to find which catalog names changed
d. If the old file doesn't exist (new creation), treats all current catalogs as changed
e. Builds a map of catalogName → Set by scanning each project's dependencies, devDependencies, and optionalDependencies for catalog: protocol entries
f. Marks affected projects and their consumingProjects as changed

How it was tested

Unit tests added for catalog change logic

Impacted documentation

Currently no documentation exists for pnpm global catalog capabilities

CarltonHowell · 2026-02-17T19:04:28Z

@microsoft-github-policy-service agree

dmichon-msft · 2026-02-18T01:04:42Z

libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts

+    }
+
+    // Determine which catalog names have changed
+    let changedCatalogNames: Set<string>;


We should be calculating for which packages given catalog specifiers have changed; a catalog reference is for a specific dependency, so just because one version in a catalog has changed doesn't mean that a different version in the catalog has changed.

Thanks David, I've addressed the feedback and added more granular tests to target this intended behaviour.

common/changes/@microsoft/rush/rush-change-catalog-entries_2026-02-17-18-48.json

Copilot

Pull request overview

Adds PNPM global catalog (globalCatalogs) change detection to rush change so that projects using the catalog: protocol are marked as changed when catalog entries are edited, including across subspaces (addresses #5624).

Changes:

Extend ProjectChangeAnalyzer.getChangedProjectsAsync() to detect diffs in per-subspace pnpm-config.json catalog entries and mark impacted projects as changed.
Add unit tests covering catalog changes (default/named catalogs) and subspace scenarios.
Add new test fixture repos (repoWithCatalogs, repoWithSubspacesCatalogs) and a Rush change file.

Reviewed changes

Copilot reviewed 29 out of 29 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts	Implements subspace-aware catalog diffing and project impact detection.
libraries/rush-lib/src/logic/test/ProjectChangeAnalyzer.test.ts	Adds unit tests for catalog change detection (including subspaces).
libraries/rush-lib/src/logic/test/repoWithCatalogs/rush.json	Test fixture Rush repo definition for catalog tests.
libraries/rush-lib/src/logic/test/repoWithCatalogs/a/package.json	Fixture project using default catalog dependencies.
libraries/rush-lib/src/logic/test/repoWithCatalogs/b/package.json	Fixture project using tools catalog (and workspace dep).
libraries/rush-lib/src/logic/test/repoWithCatalogs/c/package.json	Fixture project with no catalog dependencies.
libraries/rush-lib/src/logic/test/repoWithCatalogs/d/package.json	Fixture project using default catalog (single package).
libraries/rush-lib/src/logic/test/repoWithCatalogs/e/package.json	Fixture project using tools catalog in devDependencies.
libraries/rush-lib/src/logic/test/repoWithCatalogs/common/config/rush/pnpm-config.json	Fixture defining globalCatalogs for non-subspace repo.
libraries/rush-lib/src/logic/test/repoWithSubspacesCatalogs/rush.json	Test fixture Rush repo definition with subspaces enabled.
libraries/rush-lib/src/logic/test/repoWithSubspacesCatalogs/a/package.json	Fixture default-subspace project using default catalog.
libraries/rush-lib/src/logic/test/repoWithSubspacesCatalogs/b/package.json	Fixture default-subspace project with non-catalog dependency.
libraries/rush-lib/src/logic/test/repoWithSubspacesCatalogs/c/package.json	Fixture default-subspace project consuming a workspace dep.
libraries/rush-lib/src/logic/test/repoWithSubspacesCatalogs/d/package.json	Fixture named-subspace project using default catalog.
libraries/rush-lib/src/logic/test/repoWithSubspacesCatalogs/e/package.json	Fixture named-subspace project using tools catalog.
libraries/rush-lib/src/logic/test/repoWithSubspacesCatalogs/f/package.json	Fixture named-subspace project with no catalog deps.
libraries/rush-lib/src/logic/test/repoWithSubspacesCatalogs/g/package.json	Fixture named-subspace project using default catalog.
libraries/rush-lib/src/logic/test/repoWithSubspacesCatalogs/h/package.json	Fixture named-subspace project using tools catalog.
libraries/rush-lib/src/logic/test/repoWithSubspacesCatalogs/common/config/subspaces/default/pnpm-config.json	Fixture default subspace globalCatalogs definition.
libraries/rush-lib/src/logic/test/repoWithSubspacesCatalogs/common/config/subspaces/default/common-versions.json	Fixture default subspace common-versions config.
libraries/rush-lib/src/logic/test/repoWithSubspacesCatalogs/common/config/subspaces/default/.pnpmfile.cjs	Fixture default subspace pnpmfile.
libraries/rush-lib/src/logic/test/repoWithSubspacesCatalogs/common/config/subspaces/project-change-analyzer-test-subspace/pnpm-config.json	Fixture named subspace globalCatalogs definition.
libraries/rush-lib/src/logic/test/repoWithSubspacesCatalogs/common/config/subspaces/project-change-analyzer-test-subspace/common-versions.json	Fixture named subspace common-versions config.
libraries/rush-lib/src/logic/test/repoWithSubspacesCatalogs/common/config/subspaces/project-change-analyzer-test-subspace/.pnpmfile.cjs	Fixture named subspace pnpmfile.
libraries/rush-lib/src/logic/test/repoWithSubspacesCatalogs/common/config/rush/version-policies.json	Fixture Rush config required by test repo.
libraries/rush-lib/src/logic/test/repoWithSubspacesCatalogs/common/config/rush/subspaces.json	Fixture enabling subspaces in test repo.
libraries/rush-lib/src/logic/test/repoWithSubspacesCatalogs/common/config/rush/pnpm-config.json	Fixture root pnpm config enabling workspaces for subspaces.
libraries/rush-lib/src/logic/test/repoWithSubspacesCatalogs/common/config/rush/experiments.json	Fixture enabling cross-subspace decoupled dependency exemption for tests.
common/changes/@microsoft/rush/rush-change-catalog-entries_2026-02-17-18-48.json	Change file documenting the Rush CLI behavior update.

common/changes/@microsoft/rush/rush-change-catalog-entries_2026-02-17-18-48.json

libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts

…6-02-17-18-48.json Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

dmichon-msft

Few readability suggestions.

dmichon-msft · 2026-02-23T06:45:28Z

libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts

+      }
+    }
+
+    const changedCatalogPackages: Map<string, Set<string>> = new Map<string, Set<string>>();


Suggested change

const changedCatalogPackages: Map<string, Set<string>> = new Map<string, Set<string>>();

const changedCatalogPackages: Map<string, Set<string>> = new Map();

unnecessary verbosity

dmichon-msft · 2026-02-23T06:45:42Z

libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts

+          changedCatalogPackages.set(catalogName, new Set(Object.keys(packages)));
+          continue;
+        }
+        const changedPkgs: Set<string> = new Set<string>();


Suggested change

const changedPkgs: Set<string> = new Set<string>();

const changedPkgs: Set<string> = new Set();

dmichon-msft · 2026-02-23T06:48:14Z

libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts

+        }
+        // Check for packages that were removed from this catalog
+        for (const pkgName of Object.keys(oldPackages)) {
+          if (!(pkgName in packages)) {


packages inherits from Object.prototype, so, e.g. 'toString' in packages returns true. Need to use Object.hasOwn or Object.prototype.hasOwnProperty.call(packages, pkgName)
... or create a new Set with the keys during the iteration over Object.entries(packages) above.

dmichon-msft · 2026-02-23T06:49:19Z

libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts

+
+      // Check for catalogs that were entirely removed
+      for (const [catalogName, oldPackages] of Object.entries(oldCatalogs)) {
+        if (!(catalogName in currentCatalogs)) {


Same issue, though since Object.entries(currentCatalogs) is already invoked, we should use the array returned by that invocation to create a Map or Set for use here.

dmichon-msft · 2026-02-23T06:55:26Z

libraries/rush-lib/src/logic/ProjectChangeAnalyzer.ts

+      for (const project of subspaceProjects) {
+        const { dependencies, devDependencies, optionalDependencies, peerDependencies } = project.packageJson;
+        const allDeps: Record<string, string>[] = [
+          dependencies ?? {},
+          devDependencies ?? {},
+          optionalDependencies ?? {},
+          peerDependencies ?? {}
+        ];
+
+        let isAffected: boolean = false;
+        for (const deps of allDeps) {
+          if (isAffected) {
+            break;
+          }
+          for (const [depName, depVersion] of Object.entries(deps)) {
+            const specifier: DependencySpecifier = DependencySpecifier.parseWithCache(depName, depVersion);
+            if (specifier.specifierType === DependencySpecifierType.Catalog) {
+              // versionSpecifier holds the catalog name (empty string for "catalog:")
+              const catalogName: string = specifier.versionSpecifier || 'default';
+              const changedPkgs: Set<string> | undefined = changedCatalogPackages.get(catalogName);
+              if (changedPkgs?.has(depName)) {
+                isAffected = true;
+                break;
+              }
+            }
+          }
+        }
+
+        if (isAffected) {
+          changedProjects.add(project);
+        }
+      }
+    }


Refactor to use subspaceProjects.forEach, since having the loop iteration be a function invocation allows changedProjects.add(project); return; for more ergonomic early return.

Alternatively, or in addition, flatten allDeps first and then use a singly nested loop instead of double nested, so that you only have to break one layer up.

add pnpm global catalog detection to rush change

3a3333e

github-project-automation bot added this to Bug Triage Feb 17, 2026

github-project-automation bot moved this to Needs triage in Bug Triage Feb 17, 2026

CarltonHowell added 3 commits February 17, 2026 13:49

changelog

363cddd

remove consumers marked as changed

0f3ecd8

add additional test

49ef791

CarltonHowell marked this pull request as ready for review February 17, 2026 19:04

CarltonHowell requested review from apostolisms, bmiddha, dmichon-msft, iclanton, jxanthony and octogonz as code owners February 17, 2026 19:04

CarltonHowell mentioned this pull request Feb 17, 2026

[rush] rush change does not detect change to catalog version of dependency #5624

Open

CarltonHowell added 2 commits February 17, 2026 15:05

cater for subspaces

23161e1

remove redundant subspace logic

06b43b1

dmichon-msft reviewed Feb 18, 2026

View reviewed changes

consider namespaced catalog package version changes

04bd1c8

iclanton moved this from Needs triage to In Progress in Bug Triage Feb 18, 2026

iclanton reviewed Feb 20, 2026

View reviewed changes

common/changes/@microsoft/rush/rush-change-catalog-entries_2026-02-17-18-48.json Outdated Show resolved Hide resolved

iclanton requested a review from Copilot February 20, 2026 03:23

Copilot started reviewing on behalf of iclanton February 20, 2026 03:23 View session

Copilot AI reviewed Feb 20, 2026

View reviewed changes

CarltonHowell and others added 2 commits February 20, 2026 12:36

Update common/changes/@microsoft/rush/rush-change-catalog-entries_202…

903a12c

…6-02-17-18-48.json Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

narrow try catch and account for peerDeps

f77364c

iclanton approved these changes Feb 23, 2026

View reviewed changes

iclanton enabled auto-merge (squash) February 23, 2026 04:08

dmichon-msft reviewed Feb 23, 2026

View reviewed changes

	const changedCatalogPackages: Map<string, Set<string>> = new Map<string, Set<string>>();
	const changedCatalogPackages: Map<string, Set<string>> = new Map();

	const changedPkgs: Set<string> = new Set<string>();
	const changedPkgs: Set<string> = new Set();

Comments

Conversation

CarltonHowell commented Feb 17, 2026

Summary

Details

How it was tested

Impacted documentation

Uh oh!

CarltonHowell commented Feb 17, 2026

Uh oh!

dmichon-msft Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

CarltonHowell Feb 18, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dmichon-msft left a comment

Choose a reason for hiding this comment

Uh oh!

dmichon-msft Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

dmichon-msft Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

dmichon-msft Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

dmichon-msft Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

dmichon-msft Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants