Add 'rush-pnpm up' support for catalogs by benkeen · Pull Request #5585 · microsoft/rushstack

benkeen · 2026-01-31T22:31:19Z

Addresses: #5578

Right now, when you update packages in a Rush/pnpm repo using rush-pnpm up, it updates the catalog entries in common/temp/pnpm-workspace.yaml, but doesn't update Rush's actual catalog, stored in pnpm-config.json, so the update command doesn't fully work. This has been supported since pnpm@10.12.0. This PR enhances it to update the pnpm-config file too.

I also updated it to fix a small issue where JsonFile.save could throw an error due to an undefined $schema property.

Besides the tests, I've ran manual checks with our own Rush repo to confirm the catalog is getting updated properly.

benkeen · 2026-02-05T01:31:15Z

Howdy @iclanton, @dmichon-msft - don't suppose either of you have context or time to look at this?

iclanton · 2026-02-09T21:24:58Z

Shouldn't users be running rush update instead of rush-pnpm update?

benkeen · 2026-02-09T23:07:31Z

Huh, neat. I never associated those two commands in my mind.

rush update has a very limited, custom interface for Rush itself. What I'm trying to do is offer up all the extra options with pnpm update, for updating subsets of dependencies, like:

pnpm update -r "@babel/*"

That could always be done with rush-pnpm (but not rush update); this PR just lets that command handle catalogs too.

Tell me if I'm being barmy.

benkeen · 2026-02-18T18:02:23Z

Hey @iclanton - sorry to bug, got some time to look at this, this week? [We'd love this feature for our repo!]

benkeen · 2026-02-24T05:03:52Z

Hi @octogonz, @dmichon-msft would either of you be free for a review?

common/changes/@microsoft/rush/main_2026-01-31-22-28.json

iclanton

This overall looks fine, but would it be better to just include whatever functionality is missing from rush update?

libraries/rush-lib/src/logic/pnpm/PnpmWorkspaceFile.ts

libraries/rush-lib/src/logic/pnpm/PnpmOptionsConfiguration.ts

benkeen · 2026-02-24T16:59:07Z

This overall looks fine, but would it be better to just include whatever functionality is missing from rush update?

I see what you're saying. I'm on the fence, but I think I'd lean towards keeping them separate. Feels like we'd be overloading rush update.

Couple of thoughts:

if we did this, we'd need the rush command to work with all supported package managers, and the features and nuances of how each of those update/upgrade commands work (I haven't looked into all the available options for each). We'd only want to enhance the rush update command if it supported them all.
API-wise, we'd need to separate the "raw" pnpm update command args from the existing rush update command args so there's no conflicts when running rush update, of course. The pnpm cmd allows various arguments we'd need to offer in order to make the command useful, which could be a challenge. They seem low-level enough that I immediately went to updating the rush-pnpm wrapper.

I dunno. I'd say enhance the rush-pnpm command first, then depending on how it goes and what sort of demand is shown, consider elevating the functionality to the full rush update later.

benkeen · 2026-02-25T21:23:57Z

Updated, thanks @iclanton.

iclanton

Left some comments about test cleanup and async-ifying things.

Otherwise I think the gist of this is fine.

libraries/rush-lib/src/logic/pnpm/PnpmOptionsConfiguration.ts

libraries/rush-lib/src/logic/pnpm/PnpmWorkspaceFile.ts

libraries/rush-lib/src/logic/pnpm/PnpmOptionsConfiguration.ts

libraries/rush-lib/src/cli/test/RushPnpmCommandLineParser.test.ts

Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

…n.test.ts Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

benkeen · 2026-02-26T07:01:25Z

Updated, thanks @iclanton.

iclanton · 2026-02-26T21:01:40Z

libraries/rush-lib/src/cli/test/RushPnpmCommandLineParser.test.ts

+
+describe('RushPnpmCommandLineParser', () => {
+  describe('catalog syncing', () => {
+    const testRepoPath: string = `${MONOREPO_ROOT}/temp/catalog-sync-test-repo`;


Don't do anything outside of the project folder. Do this in <projectRoot>/temp/catalog-sync-test-repo

iclanton · 2026-02-26T21:03:32Z

libraries/rush-lib/src/cli/test/RushPnpmCommandLineParser.test.ts

+    beforeEach(async () => {
+      await FileSystem.copyFilesAsync({ sourcePath: CATALOG_SYNC_REPO_PATH, destinationPath: testRepoPath });
+
+      // common/temp is gitignored so it is not part of the static repo; copy the initial workspace file here


Can you add a .gitignore in the parent folder of with !temp?

iclanton · 2026-02-26T21:03:58Z

libraries/rush-lib/src/cli/test/RushPnpmCommandLineParser.test.ts

+    });
+
+    it('does not update pnpm-config.json when catalogs are unchanged', async () => {
+      const { PnpmWorkspaceFile } = require('../../logic/pnpm/PnpmWorkspaceFile');


Suggested change

const { PnpmWorkspaceFile } = require('../../logic/pnpm/PnpmWorkspaceFile');

const { PnpmWorkspaceFile } = await import('../../logic/pnpm/PnpmWorkspaceFile');

iclanton · 2026-02-26T21:04:13Z

libraries/rush-lib/src/cli/test/RushPnpmCommandLineParser.test.ts

+        }
+      });
+
+      const { PnpmWorkspaceFile } = require('../../logic/pnpm/PnpmWorkspaceFile');


Suggested change

const { PnpmWorkspaceFile } = require('../../logic/pnpm/PnpmWorkspaceFile');

const { PnpmWorkspaceFile } = await import('../../logic/pnpm/PnpmWorkspaceFile');

Can you just import this at the top?

iclanton · 2026-02-26T21:04:23Z

libraries/rush-lib/src/cli/test/RushPnpmCommandLineParser.test.ts

+`;
+      await FileSystem.writeFileAsync(pnpmWorkspacePath, workspaceWithoutCatalogs);
+
+      const { PnpmWorkspaceFile } = require('../../logic/pnpm/PnpmWorkspaceFile');


Suggested change

const { PnpmWorkspaceFile } = require('../../logic/pnpm/PnpmWorkspaceFile');

const { PnpmWorkspaceFile } = await import('../../logic/pnpm/PnpmWorkspaceFile');

iclanton · 2026-02-26T21:06:19Z

libraries/rush-lib/src/logic/pnpm/test/PnpmOptionsConfiguration.test.ts

+const MONOREPO_ROOT: string = path.dirname(
+  RushConfiguration.tryFindRushJsonLocation({ startingFolder: __dirname })!
+);
+const TEST_TEMP_FOLDER: string = `${MONOREPO_ROOT}/temp/pnpm-config-update-test`;


Same here, don't do things outside of the project folder.

iclanton · 2026-02-26T21:07:49Z

libraries/rush-lib/src/logic/pnpm/test/PnpmWorkspaceFile.test.ts

    });
+
+    // Mock async version for loadCatalogsFromFileAsync
+    mockExistsAsync = jest.spyOn(FileSystem, 'existsAsync').mockImplementation(async () => {


Are we doing specific existence checks? We've moved to a convention to try to read and then catch the error and check if it's a not-exist error.

iclanton · 2026-02-26T21:09:19Z

libraries/rush-lib/src/logic/pnpm/PnpmOptionsConfiguration.ts

-    if (this.jsonFilename) {
-      JsonFile.save(this._json, this.jsonFilename, { updateExistingFile: true });
-    }
+    JsonFile.save(this._json, this.jsonFilename as string, { updateExistingFile: true });


This will throw if jsonFilename is undefined. Is the property type wrong?

benkeen requested review from D4N14L, apostolisms, dmichon-msft, iclanton and octogonz as code owners January 31, 2026 22:31

github-project-automation bot added this to Bug Triage Jan 31, 2026

github-project-automation bot moved this to Needs triage in Bug Triage Jan 31, 2026

benkeen force-pushed the main branch from 893dd63 to e15378c Compare February 1, 2026 00:53

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

iclanton reviewed Feb 24, 2026

View reviewed changes

common/changes/@microsoft/rush/main_2026-01-31-22-28.json Outdated Show resolved Hide resolved

iclanton reviewed Feb 24, 2026

View reviewed changes

libraries/rush-lib/src/logic/pnpm/PnpmWorkspaceFile.ts Outdated Show resolved Hide resolved

libraries/rush-lib/src/logic/pnpm/PnpmOptionsConfiguration.ts Outdated Show resolved Hide resolved

benkeen requested review from bmiddha and jxanthony as code owners February 24, 2026 16:19

benkeen force-pushed the main branch from 115f42a to 0f3f805 Compare February 25, 2026 21:00

iclanton requested changes Feb 25, 2026

View reviewed changes

Ben Keen and others added 8 commits February 25, 2026 21:46

Add 'rush-pnpm up' support for catalogs

ea6ee3d

Update common/changes/@microsoft/rush/main_2026-01-31-22-28.json

8323e43

Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Apply code review feedback

f715b55

Update libraries/rush-lib/src/logic/pnpm/PnpmWorkspaceFile.ts

ad97f17

Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Update libraries/rush-lib/src/logic/pnpm/PnpmOptionsConfiguration.ts

a6e3c54

Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Update libraries/rush-lib/src/logic/pnpm/PnpmOptionsConfiguration.ts

46f7359

Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Update libraries/rush-lib/src/logic/pnpm/PnpmOptionsConfiguration.ts

19f5af2

Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Update libraries/rush-lib/src/cli/test/RushPnpmCommandLineParser.test.ts

89041c9

Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

benkeen and others added 16 commits February 25, 2026 21:46

Update libraries/rush-lib/src/logic/pnpm/PnpmOptionsConfiguration.ts

9507313

Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Update libraries/rush-lib/src/logic/pnpm/PnpmOptionsConfiguration.ts

cb3c760

Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Update libraries/rush-lib/src/logic/pnpm/PnpmOptionsConfiguration.ts

073c2b6

Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Update libraries/rush-lib/src/logic/pnpm/test/PnpmOptionsConfiguratio…

88b3000

…n.test.ts Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Update libraries/rush-lib/src/logic/pnpm/test/PnpmOptionsConfiguratio…

c59d56f

…n.test.ts Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Update libraries/rush-lib/src/logic/pnpm/test/PnpmOptionsConfiguratio…

d89bc91

…n.test.ts Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Update libraries/rush-lib/src/logic/pnpm/test/PnpmOptionsConfiguratio…

27445b9

…n.test.ts Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Update libraries/rush-lib/src/logic/pnpm/test/PnpmOptionsConfiguratio…

20f3cf8

…n.test.ts Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Update libraries/rush-lib/src/logic/pnpm/test/PnpmOptionsConfiguratio…

30a60dd

…n.test.ts Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Update libraries/rush-lib/src/logic/pnpm/test/PnpmOptionsConfiguratio…

fe4d784

…n.test.ts Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Update libraries/rush-lib/src/logic/pnpm/test/PnpmOptionsConfiguratio…

fa9b039

…n.test.ts Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Update libraries/rush-lib/src/logic/pnpm/test/PnpmOptionsConfiguratio…

8d44296

…n.test.ts Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Update libraries/rush-lib/src/logic/pnpm/test/PnpmOptionsConfiguratio…

3842170

…n.test.ts Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Update libraries/rush-lib/src/logic/pnpm/test/PnpmOptionsConfiguratio…

93d85a5

…n.test.ts Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Update libraries/rush-lib/src/logic/pnpm/test/PnpmOptionsConfiguratio…

1ffabcd

…n.test.ts Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

Update libraries/rush-lib/src/logic/pnpm/PnpmWorkspaceFile.ts

30064fe

Co-authored-by: Ian Clanton-Thuon <iclanton@users.noreply.github.com>

benkeen force-pushed the main branch from f3e8b7f to 27bcd6e Compare February 26, 2026 06:18

benkeen requested a review from iclanton February 26, 2026 06:20

benkeen force-pushed the main branch from 27bcd6e to 8a73a32 Compare February 26, 2026 06:34

Code review feedback - test and code cleanup

3ee9066

benkeen force-pushed the main branch from 8a73a32 to 3ee9066 Compare February 26, 2026 06:44

iclanton reviewed Feb 26, 2026

View reviewed changes

	const { PnpmWorkspaceFile } = require('../../logic/pnpm/PnpmWorkspaceFile');
	const { PnpmWorkspaceFile } = await import('../../logic/pnpm/PnpmWorkspaceFile');

Conversation

benkeen commented Jan 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

benkeen commented Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

iclanton commented Feb 9, 2026

Uh oh!

benkeen commented Feb 9, 2026

Uh oh!

benkeen commented Feb 18, 2026

Uh oh!

benkeen commented Feb 24, 2026

Uh oh!

Uh oh!

iclanton left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

benkeen commented Feb 24, 2026

Uh oh!

benkeen commented Feb 25, 2026

Uh oh!

iclanton left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

benkeen commented Feb 26, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

benkeen commented Jan 31, 2026 •

edited

Loading

benkeen commented Feb 5, 2026 •

edited

Loading