Skip to content

Commit e8c47dd

Browse files
committed
docs: add details to sideEffectsCache
close #660
1 parent 9d55714 commit e8c47dd

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/settings.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1069,6 +1069,17 @@ node_modules.
10691069

10701070
Use and cache the results of (pre/post)install hooks.
10711071

1072+
When a pre/post install script modify the contents of a package (e.g. build output), pnpm saves the modified package in the global store. On future installs on the same machine, pnpm reuses this cached, prebuilt version—making installs significantly faster.
1073+
1074+
:::note
1075+
1076+
You may want to disable this setting if:
1077+
1078+
1. The install scripts modify files *outside* the package directory (pnpm cannot track or cache these changes).
1079+
1. The scripts perform side effects that are unrelated to building the package.
1080+
1081+
:::
1082+
10721083
### sideEffectsCacheReadonly
10731084

10741085
* Default: **false**

0 commit comments

Comments
 (0)