Skip to content

fix(eslint-plugin): [no-unnecessary-template-expression] don't report when an expression includes comment #10444

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 7 commits into from
Dec 14, 2024
Merged

fix(eslint-plugin): [no-unnecessary-template-expression] don't report when an expression includes comment #10444

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e0b6a37
initial implementation
ronami Dec 2, 2024
fe8c81f
refactor and handle the case of a single string variable
ronami Dec 2, 2024
eaa7eae
refactor hasCommentsBetween => hasCommentsBetweenQuasi
ronami Dec 2, 2024
5cc8485
add an istanbul-ignore-next-comment to what seems like an unreachable…
ronami Dec 2, 2024
cfcb4a0
remove istanbul-ignore-next comment and use nullThrows instead
ronami Dec 2, 2024
fead0e0
missing tests
ronami Dec 2, 2024
869b2ae
test line comments, not just block comments
ronami Dec 3, 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
29 changes: 28 additions & 1 deletion packages/eslint-plugin/src/rules/no-unnecessary-template-expression.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ import {
getParserServices,
isTypeFlagSet,
isUndefinedIdentifier,
nullThrows,
NullThrowsReasons,
} from '../util';
import { rangeToLoc } from '../util/rangeToLoc';

Expand Down Expand Up @@ -92,6 +94,22 @@ export default createRule<[], MessageId>({
);
}

function hasCommentsBetweenQuasi(
startQuasi: TSESTree.TemplateElement,
endQuasi: TSESTree.TemplateElement,
): boolean {
const startToken = nullThrows(
context.sourceCode.getTokenByRangeStart(startQuasi.range[0]),
NullThrowsReasons.MissingToken('`${', 'opening template literal'),
);
const endToken = nullThrows(
context.sourceCode.getTokenByRangeStart(endQuasi.range[0]),
NullThrowsReasons.MissingToken('}', 'closing template literal'),
);

return context.sourceCode.commentsExistBetween(startToken, endToken);
}

return {
TemplateLiteral(node: TSESTree.TemplateLiteral): void {
if (node.parent.type === AST_NODE_TYPES.TaggedTemplateExpression) {
Expand All @@ -106,6 +124,10 @@ export default createRule<[], MessageId>({
isUnderlyingTypeString(node.expressions[0]);

if (hasSingleStringVariable) {
if (hasCommentsBetweenQuasi(node.quasis[0], node.quasis[1])) {
return;
}

context.report({
loc: rangeToLoc(context.sourceCode, [
node.expressions[0].range[0] - 2,
Expand All @@ -132,7 +154,7 @@ export default createRule<[], MessageId>({
nextQuasi: node.quasis[index + 1],
prevQuasi: node.quasis[index],
}))
.filter(({ expression, nextQuasi }) => {
.filter(({ expression, nextQuasi, prevQuasi }) => {
if (
isUndefinedIdentifier(expression) ||
isInfinityIdentifier(expression) ||
Expand All @@ -141,6 +163,11 @@ export default createRule<[], MessageId>({
return true;
}

// allow expressions that include comments
if (hasCommentsBetweenQuasi(prevQuasi, nextQuasi)) {
return false;
}

if (isLiteral(expression)) {
// allow trailing whitespace literal
if (startsWithNewLine(nextQuasi.value.raw)) {
Expand Down
54 changes: 46 additions & 8 deletions packages/eslint-plugin/tests/rules/no-unnecessary-template-expression.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,10 +310,6 @@ const invalidCases: readonly InvalidTestCase<
}\`;
`,
errors: [
{
line: 2,
messageId: 'noUnnecessaryTemplateExpression',
},
{
column: 2,
endColumn: 2,
Expand All @@ -331,12 +327,18 @@ const invalidCases: readonly InvalidTestCase<
],
output: [
`
\`use\${
\`less\`
}\`;
\`u\${
// hopefully this comment is not needed.
'se'

}le\${ \`ss\` }\`;
`,
`
\`useless\`;
\`u\${
// hopefully this comment is not needed.
'se'

}less\`;
`,
],
},
Expand Down Expand Up @@ -1104,6 +1106,42 @@ this code has trailing whitespace: \${' '}
\`trailing position interpolated empty string also makes whitespace clear \${''}
\`;
`,
`
\`
\${/* intentional comment before */ 'bar'}
...\`;
`,
`
\`
\${'bar' /* intentional comment after */}
...\`;
`,
`
\`
\${/* intentional comment before */ 'bar' /* intentional comment after */}
...\`;
`,
`
\`\${/* intentional before */ 'bar'}\`;
`,
`
\`\${'bar' /* intentional comment after */}\`;
`,
`
\`\${/* intentional comment before */ 'bar' /* intentional comment after */}\`;
`,
`
\`\${
// intentional comment before
'bar'
}\`;
`,
`
\`\${
'bar'
// intentional comment after
}\`;
`,
],

invalid: [
Expand Down
Loading