Skip to content

fix: correct Node.js version in README and increase mermaid test timeout - #30

Merged
pilat merged 1 commit into
mainfrom
chore/readme-node-version-and-test-timeout
Jul 31, 2026
Merged

fix: correct Node.js version in README and increase mermaid test timeout#30
pilat merged 1 commit into
mainfrom
chore/readme-node-version-and-test-timeout

Conversation

@pilat

@pilat pilat commented Jul 31, 2026

Copy link
Copy Markdown
Owner

README stated Node.js 20+ as the requirement, but the project actually requires Node 22+ — the engines field in package.json enforces >=22.0.0 and Node 20 reached EOL in April 2026. The Quick Start section now reflects reality.

The mermaid ELK rendering tests were hitting the default 5s timeout on slower machines — the first render of a nested subgraph diagram alone can take over 5s due to ELK layout computation. Raised the per-describe timeout to 15s for the mermaid suite.

Summary by CodeRabbit

  • Documentation

    • Updated the documented minimum Node.js requirement to version 22 or later.
  • Tests

    • Improved the reliability of Mermaid ELK rendering validation by allowing additional time for rendering-related checks. Existing rendering, hashing, filename, and regression coverage remains unchanged.

@pilat pilat self-assigned this Jul 31, 2026
@coderabbitai

coderabbitai Bot commented Jul 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: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 83ef9fff-43d9-44dd-806e-2ea11ed2c6d8

📥 Commits

Reviewing files that changed from the base of the PR and between 5d371f9 and bed1cac.

📒 Files selected for processing (2)
  • README.md
  • test/mermaid-elk.test.ts

📝 Walkthrough

Walkthrough

The README now requires Node.js 22 or newer. The Mermaid ELK rendering test suite now has a 15-second timeout.

Changes

Runtime requirement

Layer / File(s) Summary
Document Node.js 22 requirement
README.md
The documented minimum Node.js version changes from 20 to 22.

Mermaid ELK test timeout

Layer / File(s) Summary
Increase Mermaid ELK test timeout
test/mermaid-elk.test.ts
The test suite timeout increases to 15 seconds.

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

Possibly related PRs

🚥 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 summarizes both changes: the Node.js requirement update and the Mermaid ELK test timeout increase.
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.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/readme-node-version-and-test-timeout

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.

@pilat
pilat merged commit 9686ca9 into main Jul 31, 2026
3 checks passed
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