Skip to content

docs: document confirmModulesPurge - #908

Open
dvd233 wants to merge 2 commits into
pnpm:mainfrom
dvd233:codex/docs-confirm-modules-purge
Open

docs: document confirmModulesPurge#908
dvd233 wants to merge 2 commits into
pnpm:mainfrom
dvd233:codex/docs-confirm-modules-purge

Conversation

@dvd233

@dvd233 dvd233 commented Aug 31, 2026

Copy link
Copy Markdown

Summary

  • document how confirmModulesPurge controls confirmation before recreating incompatible node_modules directories
  • note that confirmation is disabled in CI
  • clarify that the setting is supported by pnpm v11 but not pnpm v12

Testing

  • pnpm test
  • English Docusaurus production build

Refs pnpm/pnpm#14316.


Written by an agent (Codex, GPT-5).

Summary by CodeRabbit

  • Documentation
    • Added documentation for the confirmModulesPurge Node-Modules setting and linked to it from the settings overview.
    • Explained its default value, Boolean type, confirmation behavior, and CI behavior.
    • Documented that installs abort when confirmation is enabled, no TTY is available, and CI is not detected.
    • Documented automatic removal and reinstallation when disabled.
    • Noted pnpm v11 support and pnpm v12 limitations.

@bolt-new-by-stackblitz

Copy link
Copy Markdown

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@qodo-code-review

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@coderabbitai

coderabbitai Bot commented Aug 31, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Team

Run ID: 48260334-faf4-4f68-9279-075cac3bb872

📥 Commits

Reviewing files that changed from the base of the PR and between 96fc5c8 and bf28bdc.

📒 Files selected for processing (1)
  • docs/settings/node-modules.md

Included review availability: Your plan provides up to 2 included reviews per hour; 0 remain after this review.

📜 Recent review details
⏰ Context from checks skipped due to timeout. (1)
  • GitHub Check: Greptile Review
🔇 Additional comments (1)
docs/settings/node-modules.md (1)

100-101: LGTM!


📝 Walkthrough

Walkthrough

The documentation links to confirmModulesPurge from the Node-Modules Settings index and describes the install-abort behavior when confirmation is required without a TTY outside CI.

Changes

Node-Modules settings documentation

Layer / File(s) Summary
Document and link confirmModulesPurge
docs/settings/node-modules.md, docs/settings.md
The setting documentation describes the non-interactive install behavior. The settings index links to the setting entry.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to bf28b

This PR only documents the existing confirmModulesPurge setting and adds a settings index link; no actionable merge-blocking risk remains beyond normal checks and review.

Suggested reviewers: zkochan

Poem

A rabbit checks the settings page
A new link marks the proper stage
When no TTY can answer clear
The install stops outside CI here
The docs now state the behavior sage

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely identifies the main change: documenting the confirmModulesPurge setting.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@greptile-apps

greptile-apps Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Confidence Score: 5/5

The PR appears safe to merge.

The previously reported documentation gap is fixed, and no blocking failure remains.

Reviews (2): Last reviewed commit: "docs: clarify no-TTY purge behavior" | Re-trigger Greptile

Comment thread docs/settings/node-modules.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant