-
-
Notifications
You must be signed in to change notification settings - Fork 2.8k
fix(eslint-plugin): [prefer-readonly] refine report locations #8894
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
Merged
JoshuaKGoldberg
merged 4 commits into
typescript-eslint:main
from
kirkwaiblinger:prefer-readonly-report-loc
Jun 17, 2024
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
import type { TSESLint, TSESTree } from '@typescript-eslint/utils'; | ||
import { | ||
nullThrows, | ||
NullThrowsReasons, | ||
} from '@typescript-eslint/utils/eslint-utils'; | ||
|
||
/** | ||
* Generates report loc suitable for reporting on how a class member is | ||
* declared, rather than how it's implemented. | ||
* | ||
* ```ts | ||
* class A { | ||
* abstract method(): void; | ||
* ~~~~~~~~~~~~~~~ | ||
* | ||
* concreteMethod(): void { | ||
* ~~~~~~~~~~~~~~ | ||
* // code | ||
* } | ||
* | ||
* abstract private property?: string; | ||
* ~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
* | ||
* @decorator override concreteProperty = 'value'; | ||
* ~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
* } | ||
* ``` | ||
*/ | ||
export function getMemberHeadLoc( | ||
sourceCode: Readonly<TSESLint.SourceCode>, | ||
node: | ||
| TSESTree.MethodDefinition | ||
| TSESTree.TSAbstractMethodDefinition | ||
| TSESTree.PropertyDefinition | ||
| TSESTree.TSAbstractPropertyDefinition, | ||
): TSESTree.SourceLocation { | ||
let start: TSESTree.Position; | ||
|
||
if (node.decorators.length === 0) { | ||
start = node.loc.start; | ||
} else { | ||
const lastDecorator = node.decorators[node.decorators.length - 1]; | ||
const nextToken = nullThrows( | ||
sourceCode.getTokenAfter(lastDecorator), | ||
NullThrowsReasons.MissingToken('token', 'last decorator'), | ||
); | ||
start = nextToken.loc.start; | ||
} | ||
|
||
let end: TSESTree.Position; | ||
|
||
if (!node.computed) { | ||
end = node.key.loc.end; | ||
} else { | ||
const closingBracket = nullThrows( | ||
sourceCode.getTokenAfter(node.key, token => token.value === ']'), | ||
NullThrowsReasons.MissingToken(']', node.type), | ||
); | ||
end = closingBracket.loc.end; | ||
} | ||
|
||
return { | ||
start: structuredClone(start), | ||
end: structuredClone(end), | ||
}; | ||
} | ||
|
||
/** | ||
* Generates report loc suitable for reporting on how a parameter property is | ||
* declared. | ||
* | ||
* ```ts | ||
* class A { | ||
* constructor(private property: string = 'value') { | ||
* ~~~~~~~~~~~~~~~~ | ||
* } | ||
* ``` | ||
*/ | ||
export function getParameterPropertyHeadLoc( | ||
sourceCode: Readonly<TSESLint.SourceCode>, | ||
node: TSESTree.TSParameterProperty, | ||
nodeName: string, | ||
): TSESTree.SourceLocation { | ||
// Parameter properties have a weirdly different AST structure | ||
// than other class members. | ||
|
||
let start: TSESTree.Position; | ||
|
||
if (node.decorators.length === 0) { | ||
start = structuredClone(node.loc.start); | ||
} else { | ||
const lastDecorator = node.decorators[node.decorators.length - 1]; | ||
const nextToken = nullThrows( | ||
sourceCode.getTokenAfter(lastDecorator), | ||
NullThrowsReasons.MissingToken('token', 'last decorator'), | ||
); | ||
start = structuredClone(nextToken.loc.start); | ||
} | ||
|
||
const end = sourceCode.getLocFromIndex( | ||
node.parameter.range[0] + nodeName.length, | ||
); | ||
|
||
return { | ||
start, | ||
end, | ||
}; | ||
} |
12 changes: 5 additions & 7 deletions
12
packages/eslint-plugin/tests/docs-eslint-output-snapshots/prefer-readonly.shot
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These functions are just moved to their own file so they can be shared