docs: fix links to settings

zkochan · zkochan · commit f0d391897e7e · 2025-04-02T09:13:29.000+02:00
diff --git a/docs/catalogs.md b/docs/catalogs.md
@@ -45,13 +45,15 @@ This is equivalent to writing a version range (e.g. `^18.3.1`) directly.
 }
 ```
 
-You may use the `catalog:` protocol in the next fields of your `package.json`:
-
-* `dependencies`
-* `devDependencies`
-* `peerDependencies`
-* `optionalDependencies`
-* `pnpm.overrides`
+You may use the `catalog:` protocol in the next fields:
+
+* `package.json`:
+  * `dependencies`
+  * `devDependencies`
+  * `peerDependencies`
+  * `optionalDependencies`
+* `pnpm-workspace.yaml`
+    * `overrides`
 
 The `catalog:` protocol allows an optional name after the colon (ex: `catalog:name`) to specify which catalog should be used. When a name is omitted, the default catalog is used.
 
diff --git a/docs/cli/add.md b/docs/cli/add.md
@@ -224,7 +224,7 @@ Example:
 pnpm --allow-build=esbuild add my-bundler
 ```
 
-This will run `esbuild`'s postinstall script and also add it to the `pnpm.onlyBuiltDependencies` field of `package.json`. So, `esbuild` will always be allowed to run its scripts in the future.
+This will run `esbuild`'s postinstall script and also add it to the `onlyBuiltDependencies` field of `pnpm-workspace.yaml`. So, `esbuild` will always be allowed to run its scripts in the future.
 
 ### --filter &lt;package_selector\>
 
diff --git a/docs/cli/audit.md b/docs/cli/audit.md
@@ -10,22 +10,17 @@ If a simple update does not fix all the issues, use [overrides] to force
 versions that are not vulnerable. For instance, if `lodash@<2.1.0` is vulnerable,
 use this overrides to force `lodash@^2.1.0`:
 
-```json title="package.json"
-{
-    "pnpm": {
-        "overrides": {
-            "lodash@<2.1.0": "^2.1.0"
-        }
-    }
-}
+```yaml title="pnpm-workspace.yaml"
+overrides:
+  "lodash@<2.1.0": "^2.1.0"
 ```
 
 Or alternatively, run `pnpm audit --fix`.
 
-If you want to tolerate some vulnerabilities as they don't affect your project, you may use the [`pnpm.auditConfig.ignoreCves`] setting.
+If you want to tolerate some vulnerabilities as they don't affect your project, you may use the [`auditConfig.ignoreCves`] setting.
 
-[overrides]: ../package_json.md#pnpmoverrides
-[`pnpm.auditConfig.ignoreCves`]: ../package_json.md#pnpmauditconfigignorecves
+[overrides]: ../settings.md#overrides
+[`auditConfig.ignoreCves`]: ../settings.md#auditconfigignorecves
 
 ## Options
 
diff --git a/docs/cli/patch-commit.md b/docs/cli/patch-commit.md
@@ -5,7 +5,7 @@ title: "pnpm patch-commit <path>"
 
 Generate a patch out of a directory and save it (inspired by a similar command in Yarn).
 
-This command will compare the changes from `path` to the package it was supposed to patch, generate a patch file, save the a patch file to `patchesDir` (which can be customized by the `--patches-dir` option), and add an entry to `patchesDependencies` in the top level manifest file.
+This command will compare the changes from `path` to the package it was supposed to patch, generate a patch file, save the a patch file to `patchesDir` (which can be customized by the `--patches-dir` option), and add an entry to [`patchedDependencies`].
 
 Usage:
 
@@ -20,3 +20,5 @@ pnpm patch-commit <path>
 ### ---patches-dir &lt;patchesDir>
 
 The generated patch file will be saved to this directory. By default, patches are saved to the `patches` directory in the root of the project.
+
+[`patchedDependencies`]: ../settings.md#patcheddependencies
diff --git a/docs/cli/patch-remove.md b/docs/cli/patch-remove.md
@@ -3,7 +3,7 @@ id: patch-remove
 title: "pnpm patch-remove <pkg...>"
 ---
 
-Remove existing patch files and settings in `pnpm.patchedDependencies`.
+Remove existing patch files and settings in `patchedDependencies`.
 
 ```sh
 pnpm patch-remove foo@1.0.0 bar@1.0.1
diff --git a/docs/cli/patch.md b/docs/cli/patch.md
@@ -15,15 +15,15 @@ Usage:
 pnpm patch <pkg name>@<version>
 ```
 
-[`patchedDependencies`]: ../package_json.md#pnpmpatcheddependencies
+[`patchedDependencies`]: ../settings.md#patcheddependencies
 
 :::note
 
 If you want to change the dependencies of a package, don't use patching to modify the `package.json` file of the package. For overriding dependencies, use [overrides] or a [package hook].
 
 :::
 
-[overrides]: ../package_json#pnpmoverrides
+[overrides]: ../settings.md#overrides
 [package hook]: ../pnpmfile#hooksreadpackagepkg-context-pkg--promisepkg
 
 <iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/0GjLqRGRbcY" title="The pnpm patch command demo" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; fullscreen"></iframe>
diff --git a/docs/config-dependencies.md b/docs/config-dependencies.md
@@ -7,21 +7,16 @@ Configurational dependencies are installed before all the other types of depende
 
 Configurational dependencies cannot have dependencies of their own or lifecycle scripts. They should be added using exact version and the integrity checksum. Example:
 
-```json
-{
-  "pnpm": {
-    "configDependencies": {
-      "my-configs": "1.0.0+sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw=="
-    }
-  }
-}
+```yaml title="pnpm-workspace.yaml"
+configDependencies:
+  my-configs: "1.0.0+sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw=="
 ```
 
 ## Usage
 
 ### Loading an allow list of built dependencies
 
-You may load a list of package names that are allowed to be built via configurational dependencies and the [`pnpm.onlyBuiltDependenciesFile`] setting. For example, you may publish a package with an `allow.json` file in its root directory:
+You may load a list of package names that are allowed to be built via configurational dependencies and the [`onlyBuiltDependenciesFile`] setting. For example, you may publish a package with an `allow.json` file in its root directory:
 
 ```json
 [
@@ -30,22 +25,17 @@ You may load a list of package names that are allowed to be built via configurat
 ]
 ```
 
-Let's say this package is called `my-configs`, then your project's `package.json` will look like this:
+Let's say this package is called `my-configs`, then your project's `pnpm-workspace.yaml` will look like this:
 
-```json
-{
-  "pnpm": {
-    "configDependencies": {
-      "my-configs": "1.0.0+sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw=="
-    },
-    "onlyBuiltDependenciesFile": "node_modules/.pnpm-config/my-configs/allow.json"
-  }
-}
+```yaml
+configDependencies:
+  my-configs: "1.0.0+sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw=="
+onlyBuiltDependenciesFile: "node_modules/.pnpm-config/my-configs/allow.json"
 ```
 
 This way your project will load the list of packages that are allowed to be built from `my-configs`.
 
-[`pnpm.onlyBuiltDependenciesFile`]: package_json.md#pnpmonlybuiltdependenciesfile
+[`onlyBuiltDependenciesFile`]: settings.md#onlybuiltdependenciesfile
 
 ### Installing dependencies used in hooks
 
@@ -69,17 +59,11 @@ module.exports = {
 
 You can reference [patch files] installed via configurational dependencies. For instance, if you have a configurational dependency called "my-patches", you can load patches from it:
 
-```json
-{
-  "pnpm": {
-    "configDependencies": {
-      "my-patches": "1.0.0+sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw=="
-    },
-    "patchedDependencies": {
-      "react": "node_modules/.pnpm-config/my-patches/react.patch"
-    }
-  }
-}
+```yaml
+configDependencies:
+  my-patches: "1.0.0+sha512-30iZtAPgz+LTIYoeivqYo853f02jBYSd5uGnGpkFV0M3xOt9aN73erkgYAmZU43x4VfqcnLxW9Kpg3R5LC4YYw=="
+patchedDependencies:
+  react: "node_modules/.pnpm-config/my-patches/react.patch"
 ```
 
 [patch files]: ./cli/patch.md
diff --git a/docs/errors.md b/docs/errors.md
@@ -35,7 +35,10 @@ To fix this error, all dependencies that use the [workspace protocol] should be
 
 `pnpm install` will fail if the project has unresolved peer dependencies or the peer dependencies are not matching the wanted ranges. To fix this, install the missing peer dependencies.
 
-You may also selectively ignore these errors using the [pnpm.peerDependencyRules.ignoreMissing](package_json#pnpmpeerdependencyrulesignoremissing) and [pnpm.peerDependencyRules.allowedVersions](package_json#pnpmpeerdependencyrulesallowedversions) fields in `package.json`.
+You may also selectively ignore these errors using the [peerDependencyRules.ignoreMissing] and [peerDependencyRules.allowedVersions] settings.
+
+[peerDependencyRules.ignoreMissing]: settings#peerdependencyrulesignoremissing
+[peerDependencyRules.allowedVersions]: settings#peerdependencyrulesallowedversions
 
 ## ERR_PNPM_OUTDATED_LOCKFILE
 
diff --git a/docs/pnpmfile.md b/docs/pnpmfile.md
@@ -79,7 +79,7 @@ Removing the `scripts` field from a dependency's manifest via `readPackage` will
 not prevent pnpm from building the dependency. When building a dependency, pnpm
 reads the `package.json` of the package from the package's archive, which is not
 affected by the hook. In order to ignore a package's build, use the
-[pnpm.neverBuiltDependencies](package_json.md#pnpmneverbuiltdependencies) field.
+[neverBuiltDependencies](settings.md#neverbuiltdependencies) field.
 
 ### `hooks.afterAllResolved(lockfile, context): lockfile | Promise<lockfile>`
 
diff --git a/docs/settings.md b/docs/settings.md
@@ -1048,11 +1048,11 @@ Do not execute any scripts of the installed packages. Scripts of the projects ar
 
 :::note
 
-Since v10, pnpm doesn't run the lifecycle scripts of dependencies unless they are listed in the [`pnpm.onlyBuiltDependencies`] field of `package.json`.
+Since v10, pnpm doesn't run the lifecycle scripts of dependencies unless they are listed in [`onlyBuiltDependencies`].
 
 :::
 
-[`pnpm.onlyBuiltDependencies`]: package_json.md#pnpmonlybuiltdependencies
+[`onlyBuiltDependencies`]: settings.md#onlybuiltdependencies
 
 ### childConcurrency
 
@@ -1193,9 +1193,9 @@ Use this `pnpm-workspace.yaml` file:
 useNodeVersion: 16.16.0
 ```
 
-This setting works only in a `pnpm-workspace.yaml` file that is in the root of your workspace. If you need to specify a custom Node.js for a project in the workspace, use the [`pnpm.executionEnv.nodeVersion`] field of `package.json` instead.
+This setting works only in a `pnpm-workspace.yaml` file that is in the root of your workspace. If you need to specify a custom Node.js for a project in the workspace, use the [`executionEnv.nodeVersion`] field of `package.json` instead.
 
-[`pnpm.executionEnv.nodeVersion`]: ./package_json.md#pnpmexecutionenvnodeversion
+[`executionEnv.nodeVersion`]: ./settings.md.md#pnpmexecutionenvnodeversion
 
 ### nodeVersion
 
