Skip to content

fix(eslint-plugin): [ban-ts-comment] more accurate handling of multiline comments #8416

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.

Sign up for GitHub

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
merged 6 commits into from
Mar 18, 2024
Merged

fix(eslint-plugin): [ban-ts-comment] more accurate handling of multiline comments #8416

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2c281c6
fix(eslint-plugin): [ban-ts-comment] more accurate handling of multil…
auvred Feb 5, 2024
423f072
chore: merge main
auvred Feb 9, 2024
c0f5007
chore: revert suggesstion message
auvred Feb 9, 2024
491eab5
Merge branch 'main'
JoshuaKGoldberg Feb 23, 2024
02ebc0f
Merge branch 'main' into fix/8368
auvred Feb 28, 2024
a108410
chore: resolve conflicts with main
auvred Mar 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 73 additions & 18 deletions packages/eslint-plugin/src/rules/ban-ts-comment.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type { TSESLint } from '@typescript-eslint/utils';
import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
import { AST_TOKEN_TYPES } from '@typescript-eslint/utils';

import { createRule, getStringLength } from '../util';
import { createRule, getStringLength, nullThrows } from '../util';

type DirectiveConfig =
| boolean
Expand All @@ -16,7 +16,7 @@ interface Options {
minimumDescriptionLength?: number;
}

export const defaultMinimumDescriptionLength = 3;
const defaultMinimumDescriptionLength = 3;

type MessageIds =
| 'tsDirectiveComment'
Expand All @@ -25,6 +25,11 @@ type MessageIds =
| 'tsDirectiveCommentRequiresDescription'
| 'replaceTsIgnoreWithTsExpectError';

interface MatchedTSDirective {
directive: string;
description: string;
}

export default createRule<[Options], MessageIds>({
name: 'ban-ts-comment',
meta: {
Expand Down Expand Up @@ -95,14 +100,18 @@ export default createRule<[Options], MessageIds>({
},
],
create(context, [options]) {
// https://github.com/microsoft/TypeScript/blob/6f1ad5ad8bec5671f7e951a3524b62d82ec4be68/src/compiler/parser.ts#L10591
const singleLinePragmaRegEx =
/^\/\/\/?\s*@ts-(?<directive>check|nocheck)(?<description>.*)$/;

/*
The regex used are taken from the ones used in the official TypeScript repo -
https://github.com/microsoft/TypeScript/blob/408c760fae66080104bc85c449282c2d207dfe8e/src/compiler/scanner.ts#L288-L296
https://github.com/microsoft/TypeScript/blob/6f1ad5ad8bec5671f7e951a3524b62d82ec4be68/src/compiler/scanner.ts#L340-L348
*/
const commentDirectiveRegExSingleLine =
/^\/*\s*@ts-(?<directive>expect-error|ignore|check|nocheck)(?<description>.*)/;
/^\/*\s*@ts-(?<directive>expect-error|ignore)(?<description>.*)/;
const commentDirectiveRegExMultiLine =
/^\s*(?:\/|\*)*\s*@ts-(?<directive>expect-error|ignore|check|nocheck)(?<description>.*)/;
/^\s*(?:\/|\*)*\s*@ts-(?<directive>expect-error|ignore)(?<description>.*)/;

const descriptionFormats = new Map<string, RegExp>();
for (const directive of [
Expand All @@ -117,22 +126,66 @@ export default createRule<[Options], MessageIds>({
}
}

function execDirectiveRegEx(
regex: RegExp,
str: string,
): MatchedTSDirective | null {
const match = regex.exec(str);
if (!match) {
return null;
}

const { directive, description } = nullThrows(
match.groups,
'RegExp should contain groups',
);
return {
directive: nullThrows(
directive,
'RegExp should contain "directive" group',
),
description: nullThrows(
description,
'RegExp should contain "description" group',
),
};
}

function findDirectiveInComment(
comment: TSESTree.Comment,
): MatchedTSDirective | null {
if (comment.type === AST_TOKEN_TYPES.Line) {
const matchedPragma = execDirectiveRegEx(
singleLinePragmaRegEx,
`//${comment.value}`,
);
Comment on lines +158 to +161
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps to be fully consistent with TypeScript's behavior, we should even check that this comment is in the begging of the file. Because // @ts-nocheck placed after some code is not a valid pragma. Sounds like a good followup, wdyt?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I'd +1 filing that as an issue.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here it is - #8753

if (matchedPragma) {
return matchedPragma;
}

return execDirectiveRegEx(
commentDirectiveRegExSingleLine,
comment.value,
);
}

const commentLines = comment.value.split('\n');
return execDirectiveRegEx(
commentDirectiveRegExMultiLine,
commentLines[commentLines.length - 1],
);
}

return {
Program(): void {
const comments = context.sourceCode.getAllComments();

comments.forEach(comment => {
const regExp =
comment.type === AST_TOKEN_TYPES.Line
? commentDirectiveRegExSingleLine
: commentDirectiveRegExMultiLine;

const match = regExp.exec(comment.value);
const match = findDirectiveInComment(comment);
if (!match) {
return;
}
// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const { directive, description } = match.groups!;
const { directive, description } = match;

const fullDirective = `ts-${directive}` as keyof Options;

Expand Down Expand Up @@ -174,12 +227,14 @@ export default createRule<[Options], MessageIds>({
option === 'allow-with-description' ||
(typeof option === 'object' && option.descriptionFormat)
) {
const {
minimumDescriptionLength = defaultMinimumDescriptionLength,
} = options;
const { minimumDescriptionLength } = options;
const format = descriptionFormats.get(fullDirective);
if (
getStringLength(description.trim()) < minimumDescriptionLength
getStringLength(description.trim()) <
nullThrows(
minimumDescriptionLength,
'Expected minimumDescriptionLength to be set',
)
) {
context.report({
data: { directive, minimumDescriptionLength },
Expand Down
Loading