Docs: Clarify the meaning of range #14166
Closed
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
eslint-github-bot
bot
added
the
triage
mdjermanovic
added
accepted
mdjermanovic
reviewed
Mar 2, 2021
| * `replaceText(nodeOrToken, text)` - replaces the text in the given node or token | ||
| * `replaceTextRange(range, text)` - replaces the text in the given range | ||
| * `replaceTextRange(nodeOrToken.range, text)` - replaces the text in the given range |
There was a problem hiding this comment.
I think it's better to describe data structure.
*Range methods are commonly used when the range isn't directly taken from a single node/token, but calculated. Most often from other token's ranges, like in this example, but it also doesn't have to be related to any nodes/tokens, as in this example.
If we want to replace a single node/token, we can just call replaceText(nodeOrToken, text).
There was a problem hiding this comment.
Yeah, that’s a good point. The range is just a two-item array of the starting index and ending index, which exists naturally on nodes or tokens as a range property but can be manually created too.
|
Closing due to age |
|
New PR: #15174 |
eslint-github-bot
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
It was not obvious where the
rangeis coming from. This shows where you'd get it.I could maybe describe the data structure but I figured this is enough because once you know how to obtain it, you might as well log it and see the data structure for yourself.
Is there anything you'd like reviewers to focus on?
Nope