Skip to content
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

Jump to bottom

no-empty-file: Fix false positive with triple-slash directives #1605

Merged
merged 6 commits into from
Nov 15, 2021
Merged

no-empty-file: Fix false positive with triple-slash directives #1605

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
a08a6cb
Fixes `no-empty-file` false positive with triple-slash directives.
manovotny Nov 11, 2021
64f1812
Looks for triple-slash directive instead of filename.
manovotny Nov 12, 2021
66a1616
Changes comments from node lookup to `sourceCode.getAllComments()`.
manovotny Nov 12, 2021
f28d616
Merge branch 'main' into fix-no-empty-file-false-positive-triple-slas…
manovotny Nov 12, 2021
c4cfca7
Simplifies directive check by removing double negative.
manovotny Nov 12, 2021
d9f76cd
Splits triple-slash directive check into it's own check for better pe…
manovotny Nov 12, 2021
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
13 changes: 13 additions & 0 deletions rules/no-empty-file.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ const isEmpty = node =>
|| node.type === 'EmptyStatement'
|| (node.type === 'ExpressionStatement' && 'directive' in node);

const isTripleSlashDirective = node =>
node.type === 'Line' && node.value.startsWith('/');

const hasTripeSlashDirectives = comments =>
comments.some(currentNode => isTripleSlashDirective(currentNode));

/** @param {import('eslint').Rule.RuleContext} context */
const create = context => {
const filename = context.getPhysicalFilename().toLowerCase();
Expand All @@ -27,6 +33,13 @@ const create = context => {
return;
}

const sourceCode = context.getSourceCode();
const comments = sourceCode.getAllComments();

if (hasTripeSlashDirectives(comments)) {
return;
}

return {
node,
messageId: MESSAGE_ID,
Expand Down
4 changes: 4 additions & 0 deletions test/no-empty-file.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ test.snapshot({
'svelte',
'tsx',
].map(extension => ({code: '', filename: `example.${extension}`})),
...[
'd.ts',
'ts',
].map(extension => ({code: '/// <reference types="example" />', filename: `example.${extension}`})),
],
invalid: [
...[
Expand Down