Skip to content

Conversation

@arpit-jn
Copy link
Contributor

@arpit-jn arpit-jn commented Jan 7, 2026

By submitting a PR to this repository, you agree to the terms within the Auth0 Code of Conduct. Please see the contributing guidelines for how to create and submit a high-quality PR for this repo.

Description

This PR adds the engines field to package.json to explicitly specify the minimum Node.js version requirement.

Problem:

  • Developers using Node.js versions below 18.18.0 encounter confusing EBADENGINE warnings from @typescript-eslint/* packages without a clear indication of the root cause
  • The CI pipeline uses Node 18, but this requirement was not documented, leading to "works in CI but not locally" issues

Solution:

"engines": {
  "node": ">=18.18.0"
}

Why 18.18.0?

  • Aligns with @typescript-eslint/* packages which require ^18.18.0 || ^20.9.0 || >=21.1.0
  • Matches the Node version used in CI workflows (node-version: 18)

Impact:

  • Non-breaking: The engines field only produces warnings by default, not hard failures
  • Users can still install with --ignore-engines if needed
  • Improves developer experience by making implicit requirements explicit

References

  • Node.js 18.18.0 release: https://nodejs.org/en/blog/release/v18.18.0

Checklist

  • I have added documentation for new/changed functionality in this PR or in auth0.com/docs
  • All active GitHub checks for tests, formatting, and security are passing
  • The correct base branch is being used, if not the default branch

@arpit-jn arpit-jn requested a review from a team as a code owner January 7, 2026 12:00
@yogeshchoudhary147 yogeshchoudhary147 merged commit ecb5490 into main Jan 8, 2026
10 checks passed
@yogeshchoudhary147 yogeshchoudhary147 deleted the add-engines-field branch January 8, 2026 09:29
yogeshchoudhary147 added a commit that referenced this pull request Jan 8, 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.

3 participants