-
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(eslint-plugin): [prefer-readonly] refine report locations (#8894)
* [prefer-readonly] Refine report locations * wip * bring stuff to shared code * lint
- Loading branch information
1 parent
1788214
commit 50ed604
Showing
5 changed files
with
369 additions
and
146 deletions.
There are no files selected for viewing
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
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
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
| 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.