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

[Content] The need to require a Node.js version is not specified in JavaScript Guidelines #666

Open
1 task
possumbilities opened this issue Sep 16, 2022 · 1 comment
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing feature 🟩 priority: low Low priority and doesn't need to be rushed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work
Projects

Comments

@possumbilities
Copy link
Contributor

possumbilities commented Sep 16, 2022

Problem

Currently there is not a consistent method across repositories for requiring a minimum Node.js version. This can and will create issues for contributing to repositories.

Description

This can be solved by adding guidance in the Javascript Guidelines to add:

"engines" : { "npm" : ">=x.y.z","node" : ">=x.yz"} to the package.json file as a baseline standard

Alternatives

Additionally, you can edit the .npmrc file to contain:

# .npmrc
engine-strict=true

but this provides inconsistent behavior, as local devs may have their own pre-existing .npmrc file.

A .nvmrc route is also possible and might have better outcomes

Additional context

Implementation

  • I would be interested in implementing this feature.
@possumbilities possumbilities added 🟩 priority: low Low priority and doesn't need to be rushed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work ✨ goal: improvement Improvement to an existing feature 💻 aspect: code Concerns the software code in the repository labels Sep 16, 2022
@cc-open-source-bot cc-open-source-bot added this to Ready for Development in Active Sprint Sep 16, 2022
@cc-open-source-bot cc-open-source-bot removed this from Ready for Development in Active Sprint Sep 16, 2022
@cc-open-source-bot cc-open-source-bot added this to Pending Review in Backlog Sep 16, 2022
@possumbilities possumbilities moved this from Pending Review to Open Source Community in Backlog Sep 19, 2022
@456535688765
Copy link

So just have to include the instruction @possumbilities

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing feature 🟩 priority: low Low priority and doesn't need to be rushed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work
2 participants