Skip to content

Update Node.js and pnpm requirements#127

Merged
ashcoft merged 3 commits into
masterfrom
update-node-pnpm-requirements-2659843271348179647
May 19, 2026
Merged

Update Node.js and pnpm requirements#127
ashcoft merged 3 commits into
masterfrom
update-node-pnpm-requirements-2659843271348179647

Conversation

@ashcoft
Copy link
Copy Markdown
Owner

@ashcoft ashcoft commented May 19, 2026

This PR updates the project's development prerequisites to align with the requirements for @mlightcad/cad-viewer.

Changes:

  • package.json: Set engines.node to >=24 and added engines.pnpm to >=10.
  • @types/node: Updated to ^24.12.4.
  • Documentation: Updated README.md, docs/DEVELOPMENT.md, and AGENTS.md to include Node.js 24+ and pnpm 10+ as requirements. Added pnpm usage instructions to AGENTS.md.
  • package-lock.json: Regenerated to include the updated @types/node.

Verified with npm test and npm install to ensure package availability and baseline stability.


PR created automatically by Jules for task 2659843271348179647 started by @ashcoft

Summary by CodeRabbit

  • Chores
    • Updated minimum Node.js requirement to version 24 or higher.
    • Added support for pnpm 10+ as the preferred package manager, with npm and yarn as alternatives.
    • Updated @types/node dependency to the latest compatible version.
    • Updated installation and setup instructions in documentation.

Review Change Stack

- Updated `package.json` engines to require Node.js >= 24 and pnpm >= 10.
- Updated `@types/node` to ^24.12.4.
- Updated `README.md`, `docs/DEVELOPMENT.md`, and `AGENTS.md` to reflect these requirements.
- Updated `package-lock.json` via `npm install`.

Co-authored-by: ashcoft <1115854+ashcoft@users.noreply.github.com>
@google-labs-jules
Copy link
Copy Markdown
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 19, 2026

Warning

Rate limit exceeded

@ashcoft has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 24 minutes and 20 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 4de3cfed-c658-4c83-8cf0-e461b0c4a88a

📥 Commits

Reviewing files that changed from the base of the PR and between 44d2b87 and 45521bc.

📒 Files selected for processing (2)
  • README.md
  • docs/DEVELOPMENT.md
📝 Walkthrough

Walkthrough

This PR standardizes the project's development tooling by requiring Node.js 24+, establishing pnpm 10+ as the preferred package manager, and updating all development documentation and installation instructions to reflect these new constraints.

Changes

Development Tooling & Engine Constraints

Layer / File(s) Summary
Engine constraints and typed dependencies
package.json
Node.js engine requirement updated from `^20
Development documentation and installation guidance
README.md, AGENTS.md, docs/DEVELOPMENT.md
README requirements table and development prerequisites updated to list pnpm 10+ (preferred) with npm or yarn as alternatives. AGENTS.md frontend installation instructions split to support both pnpm with standard pnpm install and npm with --legacy-peer-deps flag. DEVELOPMENT.md prerequisites clarified to prioritize pnpm 10+ locally.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Suggested labels

dependencies, javascript, documentation

Poem

🐰 A rabbit hops through version trees,
pnpm ten and Node twenty-four please!
The docs now sing with tooling bright,
Package and types aligned just right! ✨

🚥 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 accurately and concisely describes the main change: updating Node.js and pnpm version requirements across the project files.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch update-node-pnpm-requirements-2659843271348179647

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 and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
README.md (1)

63-65: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add --legacy-peer-deps flag to npm install commands.

All npm install commands should include the --legacy-peer-deps flag due to peer dependency conflicts in the @mlightcad packages. This is properly documented in AGENTS.md but missing from these user-facing instructions. Based on learnings, when using npm for frontend dependencies, always use the --legacy-peer-deps flag.

📝 Proposed fix
 4. Build the frontend assets:
    ```bash
    cd cad_viewer
-   npm install
+   npm install --legacy-peer-deps
    npm run build
    ```
 # Install dependencies
-npm install
+npm install --legacy-peer-deps

```diff
 1. Update the dependency:
    ```bash
-   npm update `@mlightcad/cad-viewer`
+   npm update `@mlightcad/cad-viewer` --legacy-peer-deps
    ```
 1. Clear node_modules and reinstall:
    ```bash
    rm -rf node_modules
-   npm install
+   npm install --legacy-peer-deps
    ```

Also applies to: 106-107, 159-159, 204-204

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 63 - 65, Update all user-facing npm commands in
README.md to include the --legacy-peer-deps flag: replace occurrences of the
literal command "npm install" with "npm install --legacy-peer-deps" (including
the install after "rm -rf node_modules") and change "npm update
`@mlightcad/cad-viewer`" to "npm update `@mlightcad/cad-viewer` --legacy-peer-deps"
so every instruction using npm for frontend dependencies uses the flag described
in AGENTS.md.
docs/DEVELOPMENT.md (1)

16-17: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add --legacy-peer-deps flag to npm install command.

The npm install command should include the --legacy-peer-deps flag due to peer dependency conflicts in the @mlightcad packages. This is properly documented in AGENTS.md. Based on learnings, when using npm for frontend dependencies, always use the --legacy-peer-deps flag.

📝 Proposed fix
 3. Install dependencies:
    ```bash
-   npm install
+   npm install --legacy-peer-deps
    ```
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/DEVELOPMENT.md` around lines 16 - 17, Update the npm install instruction
in DEVELOPMENT.md to include the --legacy-peer-deps flag (replace the current
"npm install" command with "npm install --legacy-peer-deps") so frontend
dependency installation uses legacy peer deps resolution consistent with
AGENTS.md and avoids `@mlightcad` peer dependency conflicts.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Outside diff comments:
In `@docs/DEVELOPMENT.md`:
- Around line 16-17: Update the npm install instruction in DEVELOPMENT.md to
include the --legacy-peer-deps flag (replace the current "npm install" command
with "npm install --legacy-peer-deps") so frontend dependency installation uses
legacy peer deps resolution consistent with AGENTS.md and avoids `@mlightcad` peer
dependency conflicts.

In `@README.md`:
- Around line 63-65: Update all user-facing npm commands in README.md to include
the --legacy-peer-deps flag: replace occurrences of the literal command "npm
install" with "npm install --legacy-peer-deps" (including the install after "rm
-rf node_modules") and change "npm update `@mlightcad/cad-viewer`" to "npm update
`@mlightcad/cad-viewer` --legacy-peer-deps" so every instruction using npm for
frontend dependencies uses the flag described in AGENTS.md.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f8f82d05-5919-496b-806a-c2288b9af181

📥 Commits

Reviewing files that changed from the base of the PR and between 090f85c and 44d2b87.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (4)
  • AGENTS.md
  • README.md
  • docs/DEVELOPMENT.md
  • package.json

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 5 files

Re-trigger cubic

@ashcoft ashcoft merged commit 06de444 into master May 19, 2026
11 of 13 checks passed
@ashcoft ashcoft deleted the update-node-pnpm-requirements-2659843271348179647 branch May 20, 2026 18:47
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