feat: add support for pnpm catalogs #5467
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Aramis Sennyey <[email protected]>
Signed-off-by: Aramis Sennyey <[email protected]>
aramissennyeydd
requested review from
D4N14L,
apostolisms,
dmichon-msft,
iclanton and
octogonz
as code owners
aramissennyeydd
commented
Nov 25, 2025
libraries/rush-lib/src/logic/installManager/WorkspaceInstallManager.ts
Outdated
Show resolved
Hide resolved
Signed-off-by: Aramis Sennyey <[email protected]>
Signed-off-by: Aramis Sennyey <[email protected]>
Signed-off-by: Aramis Sennyey <[email protected]>
Signed-off-by: Aramis Sennyey <[email protected]>
aramissennyeydd
commented
Nov 25, 2025
Signed-off-by: Aramis Sennyey <[email protected]>
| // See LICENSE in the project root for license information. | ||
|
|
||
| import * as path from 'node:path'; | ||
| import { FileSystem } from '@rushstack/node-core-library'; |
Contributor
There was a problem hiding this comment.
How much more complicated would it be to mock FileSystem in these tests and avoid the disk accesses? Having unit tests modify the file system is very much an antipattern.
libraries/rush-lib/src/logic/pnpm/test/PnpmWorkspaceFile.test.ts
Outdated
Show resolved
Hide resolved
| .: | ||
| dependencies: | ||
| react: | ||
| specifier: 'catalog:' |
Contributor
There was a problem hiding this comment.
Since catalog: is just shorthand for catalog:default, should we prefer the latter for clarity?
Contributor
Author
There was a problem hiding this comment.
Just for this example lockfile or more generally?
Signed-off-by: Aramis Sennyey <[email protected]>
Signed-off-by: Aramis Sennyey <[email protected]>
Signed-off-by: Aramis Sennyey <[email protected]>
Signed-off-by: Aramis Sennyey <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds support for defining pnpm catalog values to pnpm-config.json. This makes updating versions across a monorepo way easier because you can specify a version once and it gets picked up in a bunch of other places.
Details
https://pnpm.io/9.x/catalogs, basically this allows using an alias for common versions to reduce the size of changesets that target global versions.
My goal is for this to resemble the existing pnpm options. Weirdly, this needs to be in the pnpm-workspace file and isn't supported as a package.json pnpm property.
How it was tested
Added unit tests.
Tested in our monorepo with a
catalog:package forinstall/updateandadd. Thecatalog:specifier works for all 3, for install, a newcatalogtop level property is added into the lockfile and for add, ifcatalog:is the global version, add will automatically use it for new packages. I also tested that the temp shrinkwrap files still work, they use the resolved version in the specifier.I will likely need a preview version to test this with publish to make sure it works there as well.
Impacted documentation
Not sure? Might need additional documentation where pnpm-options values are described.