feat!: Add getLoc/getRange to SourceCode interface #89
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
nzakas
commented
Jul 18, 2024
| * Represents a location coordinate inside the source. | ||
| * Represents the start and end coordinates of a node inside the source with an offset. | ||
| */ | ||
| export interface SourceLocationWithOffset { |
There was a problem hiding this comment.
Keeping this as it seems like it would still be helpful for developers.
nzakas
commented
Jul 18, 2024
| /** | ||
| * Represents a location coordinate inside the source with an offset. | ||
| */ | ||
| export interface PositionWithOffset extends Position { |
nzakas
commented
Jul 18, 2024
Comment on lines
+180
to
+181
| node: object, | ||
| ancestry: Array<object>, |
There was a problem hiding this comment.
Using object instead of Object to enforce that this cannot be a primitive value.
nzakas
commented
Jul 18, 2024
| @@ -222,7 +242,7 @@ export interface File { | |||
| /** | |||
| * Represents the successful result of parsing a file. | |||
| */ | |||
| export interface OkParseResult { | |||
| export interface OkParseResult<T extends object = object> { | |||
There was a problem hiding this comment.
Making this generic allows devs to specify the type of the ast property to get intellisense completions.
1 task
mdjermanovic
approved these changes
Jul 19, 2024
|
@mdjermanovic just a reminder: when it looks like a PR is ready to merge, please move to "Merge Candidates" |
|
This is blocking me currently, so going to merge to get moving again. |
Merged
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.
Prerequisites checklist
What is the purpose of this pull request?
Updates the
SourceCodeinterface withgetLoc()andgetRange()methods.What changes did you make? (Give an overview)
getLoc()method toSourceCodeinterfacegetRange()method toSourceCodeinterfaceSourceRangeinterfaceSyntaxElementtype to be a union of several popular AST-location formatsoffsetproperty toPosition, as many ASTs support thatRelated Issues
Refs eslint/eslint#18695
Is there anything you'd like reviewers to focus on?
I marked this as breaking as existing implementations of
SourceCodewould now be invalid.Also, I thought that including different formats of
SyntaxElementwould provide the best developer experience. Otherwise, I'd need to setSourceCode.asttoObject, so there would effectively be no type checking or intellisense available. I'm not sure if that makes the most sense.