Skip to content

fix(eslint-plugin): support template literals in no-html-links rule #11907

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

Open
Injora wants to merge 2 commits into
base: main
Choose a base branch
from
+55 −15
Open

fix(eslint-plugin): support template literals in no-html-links rule #11907

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
880086b
fix(eslint-plugin): support template literals in no-html-links rule
Injora Apr 6, 2026
9af66e6
fix(eslint-plugin): improve template literal support in no-html-links
Injora Apr 6, 2026
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
14 changes: 6 additions & 8 deletions packages/eslint-plugin/src/rules/__tests__/no-html-links.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ ruleTester.run('prefer-docusaurus-link', rule, {
code: '<a href="tel:123456789">Call</a>',
options: [{ignoreFullyResolved: true}],
},
{
// eslint-disable-next-line no-template-curly-in-string
code: '<a href={`https://x.com/${"docu" + "saurus"} ${"rex"}`}>Twitter</a>',
options: [{ignoreFullyResolved: true}],
},
],
invalid: [
{
Expand Down Expand Up @@ -78,13 +83,6 @@ ruleTester.run('prefer-docusaurus-link', rule, {
options: [{ignoreFullyResolved: true}],
errors: errorsJSX,
},
{
// TODO we might want to make this test pass
// Can template literals be statically pre-evaluated? (Babel can do it)
// eslint-disable-next-line no-template-curly-in-string
code: '<a href={`https://x.com/${"docu" + "saurus"} ${"rex"}`}>Twitter</a>',
options: [{ignoreFullyResolved: true}],
errors: errorsJSX,
Comment on lines -81 to -87
Copy link
Copy Markdown
Collaborator

@slorber slorber Apr 6, 2026

Choose a reason for hiding this comment

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

We don't have a unit test for when the template literals are dynamic and can't be resolved at static analysis time: we should add one to ensure it keeps failing

},

],
});
18 changes: 9 additions & 9 deletions packages/eslint-plugin/src/rules/no-html-links.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,16 +82,16 @@ export default createRule<Options, MessageIds>({
const container: TSESTree.JSXExpressionContainer = hrefAttr.value;
const {expression} = container;
if (expression.type === 'TemplateLiteral') {
// Simple static string template literals
if (
expression.expressions.length === 0 &&
expression.quasis.length === 1 &&
expression.quasis[0]?.type === 'TemplateElement' &&
isFullyResolvedUrl(String(expression.quasis[0].value.raw))
) {
return;
const firstQuasi = expression.quasis[0];
if (firstQuasi?.type === 'TemplateElement') {
const prefix = String(firstQuasi.value.raw);
if (
isFullyResolvedUrl(prefix) ||
isFullyResolvedUrl(`${prefix}dummy.com`)
Copy link
Copy Markdown
Collaborator

@slorber slorber Apr 6, 2026

Choose a reason for hiding this comment

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

I don't understand, what is dummy.com?

Copy link
Copy Markdown
Author

@Injora Injora Apr 6, 2026

Choose a reason for hiding this comment

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

Thanks for the feedback! You're right, the dummy.com hack was fragile.
I've refactored the rule to use a more robust staticPreEvaluate utility function that recursively resolves TemplateLiteral, Literal, and BinaryExpression (string concatenation) nodes at static analysis time. This allows us to correctly verify if a generated string is a fully-resolved external URL without relying on string prefixes.
I've also added several new test cases:
Statically evaluatable template literals (e.g., https://x.com/${"docu" + "saurus"}) are now correctly allowed.
String concatenation (e.g., "https://x.com/" + "docusaurus") is also supported.
Dynamic template literals (e.g., https://github.com/${repo}) are now explicitly tested to ensure they are still reported as invalid, since their final URL cannot be statically verified.
Let me know if this approach aligns better with what you had in mind :)

) {
return;
}
}
// TODO add more complex TemplateLiteral cases here
}
}
}
Expand Down