Skip to content

feat(eslint-plugin): [no-useless-template-literals] add fix suggestions #8065

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
Jan 9, 2024
Merged

feat(eslint-plugin): [no-useless-template-literals] add fix suggestions #8065

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
d832a02
feat(eslint-plugin): [no-useless-template-literals] add fix suggestions
StyleShit Dec 14, 2023
985a062
change message
StyleShit Dec 14, 2023
d36ea22
add quasis to cspell
StyleShit Dec 14, 2023
6e10062
Merge remote-tracking branch 'typescript-eslint/main' into feat/no-us…
StyleShit Dec 16, 2023
aa148cd
add some test cases
StyleShit Dec 16, 2023
1d17227
use fix instead of suggestion
StyleShit Dec 17, 2023
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
1 change: 1 addition & 0 deletions .cspell.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@
"preact",
"Premade",
"prettier's",
"quasis",
"Quickstart",
"recurse",
"redeclaration",
Expand Down
55 changes: 53 additions & 2 deletions packages/eslint-plugin/src/rules/no-useless-template-literals.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import type { TSESTree } from '@typescript-eslint/utils';
import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
import { AST_NODE_TYPES } from '@typescript-eslint/utils';
import * as ts from 'typescript';

Expand All @@ -15,7 +15,8 @@ type MessageId = 'noUselessTemplateLiteral';
export default createRule<[], MessageId>({
name: 'no-useless-template-literals',
meta: {
type: 'problem',
fixable: 'code',
type: 'suggestion',
docs: {
description: 'Disallow unnecessary template literals',
recommended: 'strict',
Expand Down Expand Up @@ -68,6 +69,22 @@ export default createRule<[], MessageId>({
context.report({
node: node.expressions[0],
messageId: 'noUselessTemplateLiteral',
fix(fixer): TSESLint.RuleFix[] {
const [prevQuasi, nextQuasi] = node.quasis;

// Remove the quasis and backticks.
return [
fixer.removeRange([
prevQuasi.range[1] - 3,
node.expressions[0].range[0],
]),

fixer.removeRange([
node.expressions[0].range[1],
nextQuasi.range[0] + 2,
]),
];
},
});

return;
Expand All @@ -83,6 +100,40 @@ export default createRule<[], MessageId>({
context.report({
node: expression,
messageId: 'noUselessTemplateLiteral',
fix(fixer): TSESLint.RuleFix[] {
const index = node.expressions.indexOf(expression);
const prevQuasi = node.quasis[index];
const nextQuasi = node.quasis[index + 1];

// Remove the quasis' parts that are related to the current expression.
const fixes = [
fixer.removeRange([
prevQuasi.range[1] - 2,
expression.range[0],
]),

fixer.removeRange([
expression.range[1],
nextQuasi.range[0] + 1,
]),
];

// Remove quotes for string literals (i.e. `'a'` will become `a`).
const isStringLiteral =
isUnderlyingTypeString(expression) &&
expression.type === AST_NODE_TYPES.Literal;

if (isStringLiteral) {
const escapedValue = expression.value.replace(
/([`$\\])/g,
'\\$1',
);

fixes.push(fixer.replaceText(expression, escapedValue));
}

return fixes;
},
});
});
},
Expand Down
Loading