Skip to content
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

chore: remove engines field from package.json #6091

Closed
wants to merge 1 commit into from

Conversation

MrHBS
Copy link

@MrHBS MrHBS commented Nov 2, 2023

Is this required?

Description

Validation

Related Issues

Check List

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I have run npx turbo lint to ensure the code follows the style guide. And run npx turbo lint:fix to fix the style errors if necessary.
  • I have run npx turbo format to ensure the code follows the style guide.
  • I have run npx turbo test to check if all tests are passing.
  • I've covered new added functionality with unit tests if necessary.

@MrHBS MrHBS requested a review from a team as a code owner November 2, 2023 19:15
Copy link

vercel bot commented Nov 2, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
nodejs-org ❌ Failed (Inspect) Nov 2, 2023 7:22pm

Copy link
Member

@AugustinMauroy AugustinMauroy left a comment

Choose a reason for hiding this comment

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

LGTM thanks for you first contribution 🎉

Copy link
Contributor

github-actions bot commented Nov 2, 2023

Unit Test Coverage Report

Lines Statements Branches Functions
Coverage: 95%
95.41% (333/349) 77.21% (61/79) 93.05% (67/72)

Unit Test Report

Tests Skipped Failures Errors Time
42 0 💤 0 ❌ 0 🔥 10.12s ⏱️

@AugustinMauroy
Copy link
Member

@ovflowd have you access to see what is the problème with Vercel ?

@ovflowd
Copy link
Member

ovflowd commented Nov 2, 2023

Why you dont check Vercel Status Website? :)

@MrHBS
Copy link
Author

MrHBS commented Nov 2, 2023

Looks like Vercel is having issues https://www.vercel-status.com/

@AugustinMauroy
Copy link
Member

AugustinMauroy commented Nov 2, 2023

Why you dont check Vercel Status Website? :)

oh I just discovered that 😅

and my first idea is "what why it's fail? Vercel take care about this ?"

@ljharb
Copy link
Member

ljharb commented Nov 2, 2023

I'm confused; why would you want to remove this? the engines field makes it explicit what versions of node the project can run on.

@ovflowd
Copy link
Member

ovflowd commented Nov 2, 2023

I'm confused; why would you want to remove this? the engines field makes it explicit what versions of node the project can run on.

Now I noticed what this PR is about. Wholeheartedly agree with @ljharb. We added the engines field exactly because we only support said versions.

@MrHBS
Copy link
Author

MrHBS commented Nov 2, 2023

@ljharb Doesn’t it only work when you have engine-strict set to true in your .npmrc?

@ljharb
Copy link
Member

ljharb commented Nov 2, 2023

@MrHBS it gives you a warning regardless, and either way it's human documentation. No package.json should ever omit engines, ever.

@MrHBS
Copy link
Author

MrHBS commented Nov 2, 2023

Well I saw this project lacked the flag in their .npmrc so I found this field redundant. Closing this since you all happen to disagree.

@MrHBS MrHBS closed this Nov 2, 2023
@MrHBS
Copy link
Author

MrHBS commented Nov 2, 2023

Btw, I could be mistaken, shouldn’t it be >=18 without the v?

@ljharb
Copy link
Member

ljharb commented Nov 2, 2023

Both are valid; see npx semver -c '>= v18' vs npx semver -c '>= 18'

@MrHBS
Copy link
Author

MrHBS commented Nov 4, 2023

@ljharb Since it is simple enough, would you want me to open a PR to add the engine-strict flag?

@ljharb
Copy link
Member

ljharb commented Nov 4, 2023

That will break installs if anything in the graph has mis-set its engines field, so no. It’s best to treat the engines field as advisory for your graph.

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.

4 participants