Skip to content

docs: document confirmModulesPurge #908

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
dvd233 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: document confirmModulesPurge #908

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
96fc5c8
docs: document confirmModulesPurge
dvd233 Aug 31, 2026
bf28bdc
docs: clarify no-TTY purge behavior
dvd233 Aug 31, 2026
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
1 change: 1 addition & 0 deletions docs/settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,7 @@ Every setting is listed below, grouped by topic. Follow a setting to read its do
* [nodePackageMapType](./settings/node-modules.md#nodepackagemaptype)
* [symlink](./settings/node-modules.md#symlink)
* [enableModulesDir](./settings/node-modules.md#enablemodulesdir)
* [confirmModulesPurge](./settings/node-modules.md#confirmmodulespurge)
* [virtualStoreDir](./settings/node-modules.md#virtualstoredir)
* [virtualStoreDirMaxLength](./settings/node-modules.md#virtualstoredirmaxlength)
* [virtualStoreOnly](./settings/node-modules.md#virtualstoreonly)
Expand Down
22 changes: 22 additions & 0 deletions docs/settings/node-modules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,28 @@ mount a modules directory with FUSE: [@pnpm/mount-modules].

[@pnpm/mount-modules]: https://www.npmjs.com/package/@pnpm/mount-modules

### confirmModulesPurge

* Default: **true** (confirmation is disabled in CI)
* Type: **Boolean**

When pnpm has to recreate a `node_modules` directory because its existing
layout is incompatible with the current install settings, this setting controls
whether pnpm asks for confirmation first. Set it to `false` to let pnpm remove
and reinstall the directory without prompting. When confirmation is enabled
but no TTY is available and CI is not detected, pnpm aborts the install instead.

```yaml title="pnpm-workspace.yaml"
confirmModulesPurge: false
```

:::note

This setting is supported by pnpm v11. pnpm v12 does not implement it and warns
that it belongs to pnpm v11.

:::

### virtualStoreDir

* Default: **node_modules/.pnpm**
Expand Down