diff --git a/docs/catalogs.md b/docs/catalogs.md index dfae70aec444..1c9e55ffd35d 100644 --- a/docs/catalogs.md +++ b/docs/catalogs.md @@ -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.