Skip to content

docs(npm): clarify node dependency behavior - #11637

Merged
jdx merged 1 commit into
mainfrom
agent/fix-npm-node-dependency
Aug 2, 2026
Merged

docs(npm): clarify node dependency behavior#11637
jdx merged 1 commit into
mainfrom
agent/fix-npm-node-dependency

Conversation

@jdx

@jdx jdx commented Aug 2, 2026

Copy link
Copy Markdown
Owner

Summary

  • clarify that the embedded npm installer does not add or install Node automatically
  • explain that Node requirements are package-specific and that an already-configured Node is only ordered ahead of npm: tools
  • remove examples that installed pnpm or Bun without selecting them via npm.package_manager
  • align backend comments and test descriptions with the scheduler's actual dependency semantics

Testing

  • cargo test test_get_dependencies
  • mise run lint-fix

AI-assisted — Tool: Codex; model: openai/gpt-5; version: unavailable.


Note

Low Risk
Documentation and comment-only alignment; no install logic changes in the diff.

Overview
Corrects npm backend docs and inline comments so they match how mise actually treats node: listing it in get_dependencies only orders an already-configured Node ahead of npm: tools; the backend does not pull Node into the install set by itself. Runtime and lifecycle-script needs are described as package-specific.

The Dependencies section now spells out when Node may still be required and drops the misleading mise use -g pnpm / bun examples that implied automatic Node or installer setup without npm.package_manager. Comments on get_dependencies, aube_embed_runtime, and the dependency unit tests are updated to the same semantics (ordering vs auto-install).

Reviewed by Cursor Bugbot for commit 64fe172. Bugbot is set up for automated code reviews on this repo. Configure here.

Summary by CodeRabbit

  • Documentation
    • Clarified when Node.js is required during npm package installation and tool execution.
    • Documented that configured Node.js is installed before npm tools, without automatic Node.js installation.
    • Removed obsolete guidance about automatic dependencies and package-manager CLI installation.
  • Refactor
    • Clarified runtime dependency behavior for npm tools and embedded execution.

@coderabbitai

coderabbitai Bot commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Central YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: a550cb35-140d-4419-8365-f6ff5f366ac1

📥 Commits

Reviewing files that changed from the base of the PR and between 832623e and 64fe172.

📒 Files selected for processing (2)
  • docs/dev-tools/backends/npm.md
  • src/backend/npm.rs

📝 Walkthrough

Walkthrough

The npm backend documentation and source comments clarify when Node.js is needed, how configured Node.js is ordered, and that the backend does not automatically install Node.js or external package-manager CLIs.

Changes

npm runtime dependency clarification

Layer / File(s) Summary
Dependency documentation and comments
docs/dev-tools/backends/npm.md, src/backend/npm.rs
Documentation and comments state that Node.js can be needed for installation lifecycle scripts, is used when configured, and is not automatically installed. Embedded aube uses configured Node.js when available and otherwise ambient Node.js.

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

Possibly related PRs

  • jdx/mise#11147: Both changes clarify npm backend Node.js and npm requirements.
  • jdx/mise#11149: This change refines dependency behavior introduced there.
  • jdx/mise#11226: Both changes address embedded-aube installation behavior.

Suggested reviewers: marukome0743

Poem

A rabbit checks the Node path bright,
Keeps runtime order neat and right.
No hidden installs beneath the moon,
Aube finds its Node when configured soon.
Documentation hops in line.

🚥 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 describes the main documentation change about npm and Node dependency behavior.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

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 2, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

The PR clarifies the npm backend’s existing dependency semantics without changing executable behavior.

  • Explains that the embedded installer does not automatically add or install Node.
  • Clarifies that configured Node participates in installation ordering and may be used by lifecycle scripts.
  • Removes package-manager examples that did not select the corresponding npm.package_manager.
  • Aligns backend comments and test descriptions with current scheduler behavior.

Confidence Score: 5/5

The PR appears safe to merge because it only corrects documentation and comments to match existing npm dependency behavior.

The dependency graph only orders tools already present in the configured install set, and the revised text accurately explains that Node is not added automatically while preserving the documented configured-or-ambient runtime behavior.

Important Files Changed

Filename Overview
docs/dev-tools/backends/npm.md Documentation now accurately distinguishes package-specific Node requirements from automatic dependency installation and removes misleading package-manager examples.
src/backend/npm.rs Comments and test descriptions are updated to describe existing dependency-ordering and ambient-Node fallback behavior; executable logic is unchanged.

Reviews (1): Last reviewed commit: "docs(npm): clarify node dependency behav..." | Re-trigger Greptile

@github-actions

github-actions Bot commented Aug 2, 2026

Copy link
Copy Markdown

Instruction counts

benchmark trend instructions Δ wall (min) Δ
env ▁▇█▄▅▄▄ 80,035,019 → 80,040,410 +0.01% 17.85 → 19.04ms +6.70%
hook-env ▁▇█▅▄▁▄ 82,068,672 → 82,191,978 +0.15% 18.48 → 18.53ms +0.27%
ls ▁▆█▄▃▂▂ 73,014,906 → 73,027,789 +0.02% 16.73 → 17.13ms +2.39%
registry ▁▃▂▆▇█▅ 49,108,436 → 49,075,565 -0.07% 12.68 → 12.27ms -3.19%
startup ▁▆▇██▇▆ 15,772,112 → 15,771,102 -0.01% 9.74 → 9.59ms -1.53%

No instruction-count regression above 1%.

Only instruction counts gate. Wall clock is shown for context — on identical hardware it moves 4-20% run to run.

Measured by tak — instruction-counted CLI benchmarks, stored in this repository's git notes.

64fe17290456 vs a8f6643f52dc · measured on the runner, not pushed to the history.

@jdx
jdx enabled auto-merge (squash) August 2, 2026 13:09
@jdx
jdx merged commit a93dc05 into main Aug 2, 2026
31 checks passed
@jdx
jdx deleted the agent/fix-npm-node-dependency branch August 2, 2026 13:17
donbeave pushed a commit to donbeave/mise that referenced this pull request Aug 3, 2026
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