Skip to content

Conversation

@Moe-Salim91156
Copy link

Added a note about the required Node.js version.

Description

Just a Quick Heads Up in the README file for what node version the project requires exactly

Motivation

Even though it’s just a small edit, this prevents setup errors like the one I encountered (EBADENGINE) when using Node.js < 24. This heads-up ensures contributors know the minimum Node.js version required to build the site.

Additional details

Related issues and pull requests

Fixes #42415

Added a note about the required Node.js version.
@Moe-Salim91156 Moe-Salim91156 requested a review from a team as a code owner December 15, 2025 23:45
@Moe-Salim91156 Moe-Salim91156 requested review from pepelsbey and removed request for a team December 15, 2025 23:45
@github-actions github-actions bot added the size/xs [PR only] 0-5 LoC changed label Dec 15, 2025
@pepelsbey
Copy link
Member

pepelsbey commented Dec 16, 2025

Hey! Thank you for the suggestion. Node.js v24 only recently became LTS and many people might still use previous versions.

But I'm afraid the README is too far away to notice. I wonder if showing a good error right in the console with a script like this would be better:

{
  "type": "module",
  "engines": {
    "node": ">=24"
  },
  "scripts": {
    "preinstall": "node -e \"import pkg from './package.json' assert { type: 'json' }; const v=pkg.engines.node.slice(2); if (process.versions.node.split('.')[0] < v) { console.error(`✖ Node.js v${v} is required.`); process.exit(1) }\""
  }
}

@caugner, what do you think?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/xs [PR only] 0-5 LoC changed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Node Version requirements in README.md

2 participants