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.

Sign up for GitHub

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

Add minimum node version to engine field in package.json #4790

Merged
merged 3 commits into from
May 20, 2020
Merged

Add minimum node version to engine field in package.json #4790

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
59b2eb5
chore(doc) : add information about the minimum node version supported
rgranger May 18, 2020
b2ffe76
chore(readme) : removes node supported version
rgranger May 18, 2020
5d768d0
chore(format) : run npm run format
rgranger May 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ It's mighty as it:
- is **unopinionated** so that you can customize it to your exact needs
- has a **growing community** and is used by [Facebook](https://code.facebook.com/posts/879890885467584/improving-css-quality-at-facebook-and-beyond/), [GitHub](https://github.com/primer/stylelint-config-primer) and [WordPress](https://github.com/ntwb/stylelint-config-wordpress/)

Minimum NodeJs version supported : v10.13.0
Copy link
Member

Choose a reason for hiding this comment

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

We can remove this line as using the engine field in the package.json will suffice. It's the standardised way of communicating a package's compatibility and will produce a warning on the CLI when npm i is used, e.g.:

npm WARN notsup Unsupported engine for stylelint@13.4.0: wanted: {"node":">=10.13.0"} (current: {"node":"8.17.0","npm":"6.13.4"})

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, line has been removed from the readme


## Example output

![Example](https://github.com/stylelint/stylelint/raw/master/example.png?raw=true)
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
},
"license": "MIT",
"author": "stylelint",
"engines": { "node" : ">=10.13.0" },
"main": "lib/index.js",
"bin": "bin/stylelint.js",
"files": [
Expand Down