This is a tracking issue for the implementation of RFC: Catalogs — Shareable dependency version specifiers. All pull requests and commits related to the initial implementation of this feature will reference this issue number.

Tasks

• Support the catalog: and catalog:default specifiers during installation.
• Support catalog:<name> specifiers during installation.
• There will likely need to be a lockfileVersion increase in the pnpm-lock.yaml file.
  • Update: This won't be required after all.
• Make pnpm outdated work. I should be able to run pnpm outdated and it should be able to list all the packages in my pnpm-workspace.yaml file that are outdated
  • fix: pnpm outdated should work with catalog: protocol #8304
• Show an error for recursive catalog references.
• Add docs. (Done at https://pnpm.io/catalogs)
• pnpm add should use the default catalog #8640
• pnpm update should update catalogs in pnpm-workspace.yaml #8641

Improvements

These would be good to have, but not required.

• Support the catalog: protocol for pnpm.overrides.
• Persist comments and white-space when updating pnpm-workspace.yaml. We don't do this for package.yaml either, but hopefully we can carry over whatever solution lands there.
• Better support sets of dependencies that should be on the same version in pnpm catalogs #8245
• Allow users to create a best-effort default catalog. We could consider an internal pnpm catalog migrate command or an external pnpm dlx @pnpm/catalog-migrate command.
• Test common automated dependency mechanisms such as Dependabot and Mend Renovate to track whether they can support catalog updates.
• Support the file: and link: protocols as catalog entries #8642

Tests

• Changing a catalog entry in pnpm-workspace.yaml causes the lock file to not be up to date.
• Catalog specifiers error out if used by external dependencies.

Rollout

• Update docs to explain how the catalog works.
• Consider a more publicly facing announcement that explains what problems catalogs solve.
  • The docs site should suffice. https://pnpm.io/catalogs

PRs

Merged into main:

• fix: update WorkspaceManifest packages field type to be non-null #8205
• refactor: store workspace manifest in @pnpm/config for reuse #8213
• refactor: improve type checking when finding workspace packages #8214
• fix: use --workspace-packages CLI over pnpm-workspace.yaml in more cases #8215

Staged onto feature branch:

• feat: create new @pnpm/catalogs.types package #8026
• feat: read catalog configs from workspace manifest #8123
• feat: create new @pnpm/catalogs.protocol-parser package #8124
• refactor: factor out isWantedDepPrefSame to extend in a future commit #8125
• feat: implement catalog protocol for publish #8225
• feat: implement catalog protocol for install #8221

Merged into main after feature branch merged

• fix: show better error when encountering external catalog protocol usage #8254
• fix: prevent catalogs using the workspace:, link:, and file: protocols #8255
• fix: reuse existing cataloged resolutions for consistency #8259
• fix: reuse catalog resolutions of npm aliases correctly #8281
• fix: preserve catalog protocol when updating project manifest #8285
• fix: skip cataloged dependencies when running pnpm update --latest #8286
• fix: pnpm outdated should work with catalog: protocol #8304