Skip to content

feat: add engines property to root package.json #260368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

rinilkunhiraman
Copy link

Description

This PR adds the engines property to the root package.json to specify the required Node.js and npm versions for VS Code development, addressing issue #252372.

Changes

  • Added engines property with Node.js version >=22.17.0 (matching the .nvmrc file)
  • Added npm version >=10.8.0 (compatible with the required Node.js version)
  • This provides clear version requirements for contributors
  • Helps prevent installation issues with unsupported Node.js/npm versions

Why this change is needed

As mentioned in the original issue, the How to Contribute guide mentions using npm install but doesn't specify which npm or Node.js versions are required. This change:

  1. Provides quick reference for required versions
  2. Prevents errors when using unsupported versions
  3. Matches existing .nvmrc specification (22.17.0)
  4. Follows npm standards for version specification

Testing

  • Verified the engines field is valid JSON
  • Confirmed Node.js version matches .nvmrc
  • Verified npm version is compatible with Node.js 22.17.0
  • No breaking changes - this is purely additive metadata

Associated Issue

Fixes #252372

- Specify minimum Node.js version as >=22.17.0 (matching .nvmrc)
- Specify minimum npm version as >=10.8.0 (compatible with Node.js 22.17.0)
- Provides clear version requirements for contributors
- Helps prevent issues with unsupported Node.js/npm versions

Fixes microsoft#252372
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.

Add engines property to root package.json
2 participants