feat(eslint-plugin): [no-useless-template-literals] rename to `no-useless-template-expression` (deprecate `no-useless-template-literals`) #8821

kirkwaiblinger · 2024-04-02T03:47:25Z

PR Checklist

Addresses an existing open issue: fixes Docs: Clarify purpose of no-useless-template-literal (or rename?) #8544
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

Copy old rule to new rule.
Deprecate rule under old name.
Lots of documentation updating.

typescript-eslint · 2024-04-02T03:47:27Z

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

netlify · 2024-04-02T03:47:40Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`4829797`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/66423646c9a00b0008679c2c
😎 Deploy Preview	https://deploy-preview-8821--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 93 (🔴 down 3 from production) Accessibility: 100 (no change from production) Best Practices: 92 (no change from production) SEO: 98 (no change from production) PWA: 80 (no change from production) View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

nx-cloud · 2024-04-02T03:48:37Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 4829797. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 31 targets

Sent with 💌 from NxCloud.

JoshuaKGoldberg

LGTM in general! Just requesting changes on some docs touchups (the suggestions). Nothing functionally blocking from me. Thanks! ✨

packages/eslint-plugin/docs/rules/no-useless-template-literals.mdx

packages/eslint-plugin/src/rules/no-useless-template-expression.ts

packages/eslint-plugin/src/rules/no-useless-template-literals.ts

packages/eslint-plugin/docs/rules/no-useless-template-literals.mdx

packages/eslint-plugin/src/rules/no-useless-template-literals.ts

packages/eslint-plugin/docs/rules/no-useless-template-expression.mdx

Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>

kirkwaiblinger · 2024-04-16T04:28:28Z

@JoshuaKGoldberg
This is a super last-minute thought, but I wonder whether we should soften it to "no-unnecessary-template-expression" instead of "no-useless-template-expression". The other no-useless-* rules are true noops that can be removed entirely, whereas this is just code that could be simplified. More in line with the no-unnecessary-* rules. We did plenty of bikeshedding on the "template-expression"/"template-interpolation"/"template-substitution" part of the rule in #8544, but didn't give the first half any thought. Not that it was the part of the name that was motivating to change, of course.

JoshuaKGoldberg · 2024-04-23T11:48:25Z

no-unnecessary-template-expression

I'm up for the no-unnecesssary preference, that's a good distinction. Thoughts @Josh-Cena ?

StyleShit · 2024-05-05T12:27:57Z

packages/eslint-plugin/docs/rules/no-throw-literal.mdx

@@ -16,10 +16,10 @@ This rule restricts what can be thrown as an exception.

 :::warning
 This rule is being renamed to [`only-throw-error`](./only-throw-error.mdx).
-When it was first created, it only prevented literals from being thrown (hence the name), but it has now been expanded to only allow expressions which have a possibility of being an `Error` object.
-With the `allowThrowingAny` and `allowThrowingUnknown` options, it can be configured to only allow throwing values which are guaranteed to be an instance of `Error`.
+The current name, `no-throw-literal`, will be removed in a future major version of typescript-eslint.


since this PR changes multiple rules, maybe we should also change its title?
(so it'll also be squashed with the proper commit message)

or maybe split tp multiple PRs?

This comes out of #8821 (comment).
I think it makes sense to include in this change set since it's such a small (and related) change.

StyleShit · 2024-05-05T12:30:15Z

packages/eslint-plugin/docs/rules/no-useless-template-expression.mdx

+
+## When Not To Use It
+
+When you want to allow string expressions inside template literals.


IIRC, it's not only for strings, it's also for other literals such as numbers, booleans, null, etc.

Yeah, true. That part of the PR is just unchanged code moved from the existing page, though. See on main:

typescript-eslint/packages/eslint-plugin/docs/rules/no-useless-template-literals.mdx

Lines 55 to 58 in f248e68

## When Not To Use It

When you want to allow string expressions inside template literals.

I don't feel strongly about it, so I would prefer not to bother changing it in this PR 🙃. Feel free to submit a separate PR to change that line if you like! 🙂

StyleShit · 2024-05-05T12:30:28Z

packages/eslint-plugin/docs/rules/no-useless-template-expression.mdx

+:::info
+This rule does not aim to flag template literals without substitution expressions that could have been written as an ordinary string.
+That is to say, this rule will not help you turn `` `this` `` into `"this"`.
+If you are looking for such a rule, you can configure the [`@stylistic/ts/quotes`](https://eslint.style/rules/ts/quotes) rule to do this.
+:::


packages/eslint-plugin/tests/docs.test.ts

codecov · 2024-05-13T15:48:49Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.39%. Comparing base (f53fece) to head (12182f5).
Report is 13 commits behind head on main.

❗ Current head 12182f5 differs from pull request most recent head 4829797

Please upload reports for the commit 4829797 to get more accurate results.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8821      +/-   ##
==========================================
- Coverage   88.04%   87.39%   -0.66%     
==========================================
  Files         410      256     -154     
  Lines       14187    12522    -1665     
  Branches     4136     3927     -209     
==========================================
- Hits        12491    10943    -1548     
+ Misses       1391     1304      -87     
+ Partials      305      275      -30

Flag	Coverage Δ
unittest	`87.39% <100.00%> (-0.66%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
...plugin/src/rules/no-useless-template-expression.ts	`100.00% <100.00%> (ø)`
...t-plugin/src/rules/no-useless-template-literals.ts	`100.00% <100.00%> (ø)`

... and 189 files with indirect coverage changes

JoshuaKGoldberg

🚀 sorry for the delay, this is great!

I'm happy for you to merge whenever you're comfortable with it.

Eugeno · 2024-06-04T05:26:19Z

"no-useless-template-expression" was renamed to "no-unnecessary-template-expression", but in the release note:

eslint-plugin: [no-useless-template-literals] rename to no-useless-template-expression (deprecate no-useless-template-literals) (#8821)

same for issues 8597, 8669, 8677.

kirkwaiblinger · 2024-06-04T18:34:05Z

@Eugeno

Yes, the premature merge was a tad unfortunate. Was amended in #9174, which went in before the release, though, so the only impact should be a small handful of slightly confusing release notes and issue/pr titles, but nothing overt to the user

Rename no-useless-template-literals to no-useless-template-expression

12182f5

kirkwaiblinger changed the title ~~Rename no-useless-template-literals to no-useless-template-expression~~ fix(eslint-plugin): [no-useless-template-literals] rename to no-useless-template-expression Apr 2, 2024

kirkwaiblinger marked this pull request as ready for review April 2, 2024 04:01

JoshuaKGoldberg added this to the 8.0.0 milestone Apr 14, 2024

JoshuaKGoldberg requested changes Apr 14, 2024

View reviewed changes

JoshuaKGoldberg reviewed Apr 14, 2024

View reviewed changes

packages/eslint-plugin/docs/rules/no-useless-template-expression.mdx Show resolved Hide resolved

kirkwaiblinger and others added 5 commits April 14, 2024 14:04

Merge branch 'main' into rename-no-useless-template-literal

11c599b

Apply suggestions from code review

0bd126f

Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>

fix syntax

6420c69

follow up on confusing typed function issue

9f56e21

copypasta approach

3c4ab99

kirkwaiblinger mentioned this pull request Apr 14, 2024

fix(eslint-plugin): [no-useless-template-literals] rename to no-useless-template-expression (ALTERNATE VERSION, copy-pasted) #8919

Closed

3 tasks

pr feedback and other changes

5431911

kirkwaiblinger requested a review from JoshuaKGoldberg April 15, 2024 17:14

kirkwaiblinger mentioned this pull request Apr 16, 2024

Repo: Ideas for avoiding drift between a renamed rule and the original #8935

Open

JoshuaKGoldberg requested a review from Josh-Cena April 26, 2024 13:55

StyleShit reviewed May 5, 2024

View reviewed changes

revert miscellaneous spelling fix

e347499

kirkwaiblinger mentioned this pull request May 13, 2024

feat(eslint-plugin): deprecate prefer-ts-expect-error in favor of ban-ts-comment #9081

Merged

3 tasks

StyleShit approved these changes May 13, 2024

View reviewed changes

Merge branch 'main' into rename-no-useless-template-literal

4829797

JoshuaKGoldberg approved these changes May 26, 2024

View reviewed changes

JoshuaKGoldberg added the 1 approval One team member has approved this PR; a second should be enough to merge it label May 26, 2024

kirkwaiblinger mentioned this pull request May 27, 2024

feat(eslint-plugin): replace ban-types with no-restricted-types, no-unsafe-function-type, no-wrapper-object-types #9102

Open

3 tasks

bradzacher changed the title ~~fix(eslint-plugin): [no-useless-template-literals] rename to no-useless-template-expression~~ feat(eslint-plugin): [no-useless-template-literals] rename to no-useless-template-expression (deprecate no-useless-template-literals) May 28, 2024

bradzacher merged commit 09ecbe2 into typescript-eslint:main May 28, 2024
59 checks passed

JoshuaKGoldberg mentioned this pull request May 28, 2024

Enhancement: [no-useless-template-literals] Delete in v8 #9163

Closed

kirkwaiblinger deleted the rename-no-useless-template-literal branch May 29, 2024 06:45

fpapado mentioned this pull request Jun 3, 2024

feat(parser, typescript-estree): export withoutProjectParserOptions utility #9233

Merged

3 tasks

kirkwaiblinger mentioned this pull request Jun 11, 2024

Docs: Release note of v7.12.0 contains critical misleading typo #9329

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(eslint-plugin): [no-useless-template-literals] rename to `no-useless-template-expression` (deprecate `no-useless-template-literals`) #8821

feat(eslint-plugin): [no-useless-template-literals] rename to `no-useless-template-expression` (deprecate `no-useless-template-literals`) #8821

kirkwaiblinger commented Apr 2, 2024 •

edited

typescript-eslint bot commented Apr 2, 2024

netlify bot commented Apr 2, 2024 •

edited

nx-cloud bot commented Apr 2, 2024 •

edited

JoshuaKGoldberg left a comment

kirkwaiblinger commented Apr 16, 2024

JoshuaKGoldberg commented Apr 23, 2024

StyleShit May 5, 2024

kirkwaiblinger May 5, 2024

StyleShit May 5, 2024

kirkwaiblinger May 5, 2024

StyleShit May 5, 2024

codecov bot commented May 13, 2024 •

edited

JoshuaKGoldberg left a comment •

edited

Eugeno commented Jun 4, 2024

kirkwaiblinger commented Jun 4, 2024


		## When Not To Use It

		When you want to allow string expressions inside template literals.

feat(eslint-plugin): [no-useless-template-literals] rename to no-useless-template-expression (deprecate no-useless-template-literals) #8821

feat(eslint-plugin): [no-useless-template-literals] rename to no-useless-template-expression (deprecate no-useless-template-literals) #8821

Conversation

kirkwaiblinger commented Apr 2, 2024 • edited

PR Checklist

Overview

typescript-eslint bot commented Apr 2, 2024

netlify bot commented Apr 2, 2024 • edited

✅ Deploy Preview for typescript-eslint ready!

nx-cloud bot commented Apr 2, 2024 • edited

☁️ Nx Cloud Report

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

kirkwaiblinger commented Apr 16, 2024

JoshuaKGoldberg commented Apr 23, 2024

StyleShit May 5, 2024

Choose a reason for hiding this comment

kirkwaiblinger May 5, 2024

Choose a reason for hiding this comment

StyleShit May 5, 2024

Choose a reason for hiding this comment

kirkwaiblinger May 5, 2024

Choose a reason for hiding this comment

StyleShit May 5, 2024

Choose a reason for hiding this comment

codecov bot commented May 13, 2024 • edited

Codecov Report

JoshuaKGoldberg left a comment • edited

Choose a reason for hiding this comment

Eugeno commented Jun 4, 2024

kirkwaiblinger commented Jun 4, 2024

feat(eslint-plugin): [no-useless-template-literals] rename to `no-useless-template-expression` (deprecate `no-useless-template-literals`) #8821

feat(eslint-plugin): [no-useless-template-literals] rename to `no-useless-template-expression` (deprecate `no-useless-template-literals`) #8821

kirkwaiblinger commented Apr 2, 2024 •

edited

netlify bot commented Apr 2, 2024 •

edited

nx-cloud bot commented Apr 2, 2024 •

edited

codecov bot commented May 13, 2024 •

edited

JoshuaKGoldberg left a comment •

edited