From 5aed81f2f4fafe5c2b0b1de283f189dd04e65f0c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kh=E1=BA=A3i?= Date: Fri, 27 Oct 2023 17:02:15 +0700 Subject: [PATCH] docs(injected): more accurate description (#471) --- docs/package_json.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/package_json.md b/docs/package_json.md index 778db132e60c..a2ce1f9b77a7 100644 --- a/docs/package_json.md +++ b/docs/package_json.md @@ -35,7 +35,9 @@ Additional meta information used for dependencies declared inside `dependencies` ### dependenciesMeta.*.injected -If this is set to true for a local dependency, the package will be hard linked to the modules directory, not symlinked. +If this is set to `true` for a local dependency, the package will be hard linked to the virtual store (`node_modules/.pnpm`) and symlinked from the virtual store to the modules directory. + +If this is set to `false` or not set for a local dependency, the package will be symlinked directly from its location in the workspace to the module directory. For instance, the following `package.json` in a workspace will create a symlink to `button` in the `node_modules` directory of `card`: @@ -278,7 +280,7 @@ The referenced package does not need to match the overridden one: "overrides": { "bar": "$foo" } - } + } } ```