Skip to content

fix(eslint-plugin): stop warning on @ts-nocheck comments which aren't at the beginning of the file #10046

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
Oct 7, 2024
Merged

fix(eslint-plugin): stop warning on @ts-nocheck comments which aren't at the beginning of the file #10046

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
4c320d2
fix ban-ts-comment for reporting false positives when @ts-nocheck is …
ronami Sep 23, 2024
c4c2cdc
adjust and add tests
ronami Sep 23, 2024
b769122
use .at() instead if indexed access
ronami Sep 23, 2024
44e5938
oops
ronami Sep 25, 2024
d0794c6
tests edge case
ronami Sep 29, 2024
d07c3ee
typo
ronami Sep 29, 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
12 changes: 11 additions & 1 deletion packages/eslint-plugin/src/rules/ban-ts-comment.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,9 @@ export default createRule<[Options], MessageIds>({
}

return {
Program(): void {
Program(node): void {
const firstStatement = node.body.at(0);

const comments = context.sourceCode.getAllComments();

comments.forEach(comment => {
Expand All @@ -192,6 +194,14 @@ export default createRule<[Options], MessageIds>({
}
const { directive, description } = match;

if (
directive === 'nocheck' &&
firstStatement &&
firstStatement.loc.start.line <= comment.loc.start.line
) {
return;
}

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

const option = options[fullDirective];
Expand Down
40 changes: 24 additions & 16 deletions packages/eslint-plugin/tests/rules/ban-ts-comment.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -992,6 +992,14 @@ ruleTester.run('ts-nocheck', rule, {
`,
'/** @ts-nocheck */',
'/* @ts-nocheck */',
`
const a = 1;

// @ts-nocheck - should not be reported

// TS error is not actually suppressed
const b: string = a;
`,
],
invalid: [
{
Expand Down Expand Up @@ -1028,22 +1036,6 @@ ruleTester.run('ts-nocheck', rule, {
},
],
},
{
code: `
if (false) {
// @ts-nocheck: Unreachable code error
console.log('hello');
}
`,
errors: [
{
data: { directive: 'nocheck' },
messageId: 'tsDirectiveComment',
line: 3,
column: 3,
},
],
},
{
code: '// @ts-nocheck',
options: [{ 'ts-nocheck': 'allow-with-description' }],
Expand Down Expand Up @@ -1127,6 +1119,22 @@ if (false) {
},
],
},
{
// comment's column > first statement's column
// eslint-disable-next-line @typescript-eslint/internal/plugin-test-formatting
Copy link
Member Author

Choose a reason for hiding this comment

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

I used an eslint-disable comment over noFormat() since it doesn't handle disabling indentation checks.

code: `
// @ts-nocheck
const a: true = false;
`,
errors: [
{
data: { directive: 'nocheck', minimumDescriptionLength: 3 },
messageId: 'tsDirectiveComment',
line: 2,
column: 2,
},
],
},
],
});

Expand Down
Loading