Skip to content

feat: add catalogMode setting desc #666

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add catalogMode setting desc #666

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/catalogs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,19 @@ Will become the following on publish.

The `catalog:` protocol replacement process allows the `@example/components` package to be used by other workspaces or package managers.

## Setting

### catalogMode

* Default: **manual**
* Type: **manual**,**strict**,**prefer**

A new `catalogMode` setting is available for controlling if and how dependencies are added to the default catalog.

* **manual** - Does not automatically add dependencies to the catalog.
* **strict** - Only allows dependency versions from the catalog. Adding a dependency outside the catalog's version range will cause an error.
* **prefer** - Prefers catalog versions, but will fall back to direct dependencies if no compatible version is found.

## Caveats

The `pnpm update` command does not yet support catalogs.
Expand Down