Mention Node version support in prefer-node-protocol rule
#1874
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ddzz
reviewed
Aug 15, 2022
docs/rules/prefer-node-protocol.md
Outdated
| @@ -11,6 +11,12 @@ When importing builtin modules, it's better to use the [`node:` protocol](https: | |||
|
|
|||
| And don't forget to [upvote this issue](https://github.com/nodejs/node/issues/38343) if you agree. | |||
|
|
|||
| Note that this feature is not available in early versions of Node 12 and Node 14: | |||
There was a problem hiding this comment.
I don't think we need to mention Node.js 12 as it's not supported anymore.
There was a problem hiding this comment.
I removed "Node 12" from this sentence. However, I do think we should continue to mention it in the versions list below for completeness / to accurately satisfy the wording "Node.js support for this feature began in". Once all of eslint-plugin-unicorn's Node versions support this feature, I think we can just remove this section completely.
|
Bump |
bmish
force-pushed
the
prefer-node-protocol-support-doc
branch
2 times, most recently
from
b79b64d
to
815ac33
Compare
bmish
force-pushed
the
prefer-node-protocol-support-doc
branch
from
815ac33
to
7bfb3a2
Compare
|
Sorry for the delay. Should be ready if still interested. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Document the supported Node versions for the node protocol import feature to reduce potential confusion or mistaken adoption of this lint rule.
While eslint-plugin-unicorn only supports Node 14.18 and above:
eslint-plugin-unicorn/package.json
Line 14 in 20e959f
Some libraries that intend to support all versions of Node 14 might accidentally adopt this lint rule since it's very common to only test against the latest Node 14 and not necessarily against early versions of it.
Fixes #1867.