fix(eslint-plugin): [no-unnecessary-template-expressions] allow template expressions used to make trailing whitespace visible #10363

kirkwaiblinger · 2024-11-20T17:27:38Z

PR Checklist

Addresses an existing open issue: fixes Bug: [no-unnecessary-template-expression] do not flag multiline template strings that interpolate trailing whitespace #10360
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

Basically just checks for an unescaped new line literal following the expression, and checks whether the expression is a whitespace literal

I used as a guiding principle "If the user has explicitly provided whitespace to end a line we won't report". This is different from "we won't ever report on an interpolation fixing which would result in terminal whitespace". For example, this code

`this has ${'whitespace after fixing       '}
`;

fixes to

`this has whitespace after fixing       
`;

and that is intentional.

It's up to a user to explicitly specify

`this has whitespace after fixing${'       '}
`;
// or
`this has whitespace after fixing       ${''}
`;

if that's what they want to do

🫡

typescript-eslint · 2024-11-20T17:27:41Z

Thanks for the PR, @kirkwaiblinger!

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-11-20T17:27:55Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`48a1c0e`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/673e20f917185f0008c36daf
😎 Deploy Preview	https://deploy-preview-10363--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 99 (🟢 up 1 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-11-20T17:31:34Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 48a1c0e. 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 2 targets

Sent with 💌 from NxCloud.

codecov · 2024-11-20T17:48:35Z

Codecov Report

Attention: Patch coverage is 94.73684% with 1 line in your changes missing coverage. Please review.

Project coverage is 86.69%. Comparing base (2444351) to head (48a1c0e).
Report is 14 commits behind head on main.

Files with missing lines	Patch %	Lines
...in/src/rules/no-unnecessary-template-expression.ts	94.73%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #10363   +/-   ##
=======================================
  Coverage   86.69%   86.69%           
=======================================
  Files         434      434           
  Lines       15227    15240   +13     
  Branches     4445     4453    +8     
=======================================
+ Hits        13201    13213   +12     
  Misses       1670     1670           
- Partials      356      357    +1

Flag	Coverage Δ
unittest	`86.69% <94.73%> (+<0.01%)`	⬆️

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

Files with missing lines	Coverage Δ
...in/src/rules/no-unnecessary-template-expression.ts	`98.75% <94.73%> (-1.25%)`	⬇️

kirkwaiblinger · 2024-11-20T17:50:26Z

packages/eslint-plugin/tests/rules/no-useless-constructor.test.ts

@@ -209,8 +209,6 @@ class A extends Object {
    `,
  ],
  invalid: [
-    /* eslint-disable @typescript-eslint/no-unnecessary-template-expression -- trailing whitespace */


JoshuaKGoldberg

Haha, what a great finding... I suppose if folks really want this behavior then they can always feature request an option for the rule.

@bkks1004

##### [v8.17.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8170-2024-12-02) ##### 🚀 Features - **eslint-plugin:** \[prefer-promise-reject-errors] options to allow any and unknown ([#10392](typescript-eslint/typescript-eslint#10392)) ##### 🩹 Fixes - **eslint-plugin:** \[promise-function-async] handle function overloading ([#10304](typescript-eslint/typescript-eslint#10304)) - **eslint-plugin:** remove references to "extendDefaults" in no-restricted-types ([#10401](typescript-eslint/typescript-eslint#10401)) - **eslint-plugin:** \[no-unnecessary-template-expressions] allow template expressions used to make trailing whitespace visible ([#10363](typescript-eslint/typescript-eslint#10363)) ##### ❤️ Thank You - Kim OhSeong [@bkks1004](https://github.com/bkks1004) - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) - Maria José Solano [@MariaSolOs](https://github.com/MariaSolOs) - Ronen Amiel You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

@bkks1004

##### [v8.17.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8170-2024-12-02) ##### 🚀 Features - **eslint-plugin:** \[prefer-promise-reject-errors] options to allow any and unknown ([#10392](typescript-eslint/typescript-eslint#10392)) ##### 🩹 Fixes - **eslint-plugin:** \[promise-function-async] handle function overloading ([#10304](typescript-eslint/typescript-eslint#10304)) - **eslint-plugin:** remove references to "extendDefaults" in no-restricted-types ([#10401](typescript-eslint/typescript-eslint#10401)) - **eslint-plugin:** \[no-unnecessary-template-expressions] allow template expressions used to make trailing whitespace visible ([#10363](typescript-eslint/typescript-eslint#10363)) ##### ❤️ Thank You - Kim OhSeong [@bkks1004](https://github.com/bkks1004) - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) - Maria José Solano [@MariaSolOs](https://github.com/MariaSolOs) - Ronen Amiel You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

@bkks1004

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.16.0 | 8.17.0 | | npm | @typescript-eslint/parser | 8.16.0 | 8.17.0 | ## [v8.17.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8170-2024-12-02) ##### 🚀 Features - **eslint-plugin:** \[prefer-promise-reject-errors] options to allow any and unknown ([#10392](typescript-eslint/typescript-eslint#10392)) ##### 🩹 Fixes - **eslint-plugin:** \[promise-function-async] handle function overloading ([#10304](typescript-eslint/typescript-eslint#10304)) - **eslint-plugin:** remove references to "extendDefaults" in no-restricted-types ([#10401](typescript-eslint/typescript-eslint#10401)) - **eslint-plugin:** \[no-unnecessary-template-expressions] allow template expressions used to make trailing whitespace visible ([#10363](typescript-eslint/typescript-eslint#10363)) ##### ❤️ Thank You - Kim OhSeong [@bkks1004](https://github.com/bkks1004) - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) - Maria José Solano [@MariaSolOs](https://github.com/MariaSolOs) - Ronen Amiel You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

@bkks1004

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.16.0 | 8.17.0 | | npm | @typescript-eslint/parser | 8.16.0 | 8.17.0 | ## [v8.17.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8170-2024-12-02) ##### 🚀 Features - **eslint-plugin:** \[prefer-promise-reject-errors] options to allow any and unknown ([#10392](typescript-eslint/typescript-eslint#10392)) ##### 🩹 Fixes - **eslint-plugin:** \[promise-function-async] handle function overloading ([#10304](typescript-eslint/typescript-eslint#10304)) - **eslint-plugin:** remove references to "extendDefaults" in no-restricted-types ([#10401](typescript-eslint/typescript-eslint#10401)) - **eslint-plugin:** \[no-unnecessary-template-expressions] allow template expressions used to make trailing whitespace visible ([#10363](typescript-eslint/typescript-eslint#10363)) ##### ❤️ Thank You - Kim OhSeong [@bkks1004](https://github.com/bkks1004) - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) - Maria José Solano [@MariaSolOs](https://github.com/MariaSolOs) - Ronen Amiel You can read about our [versioning strategy](https://main--typescript-eslint.netlify.app/users/versioning) and [releases](https://main--typescript-eslint.netlify.app/users/releases) on our website.

kirkwaiblinger added 3 commits November 20, 2024 00:40

whitespace is useful

5597d6d

no-longer-needed-disable

7d5f82e

windows stuff and template cov

b59f684

remove duplicate test case

35194ee

kirkwaiblinger changed the title ~~Necessary template expressions~~ fix(eslint-plugin): [no-unnecessary-template-expressions] allow template expressions used to make trailing whitespace visible Nov 20, 2024

tweaks

48a1c0e

kirkwaiblinger marked this pull request as ready for review November 20, 2024 17:49

kirkwaiblinger commented Nov 20, 2024

View reviewed changes

JoshuaKGoldberg approved these changes Nov 22, 2024

View reviewed changes

JoshuaKGoldberg added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Nov 22, 2024

JoshuaKGoldberg merged commit fcd6cf0 into typescript-eslint:main Nov 26, 2024
79 checks passed

kirkwaiblinger deleted the necessary-template-expressions branch November 27, 2024 01:51

github-actions bot locked as resolved and limited conversation to collaborators Dec 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(eslint-plugin): [no-unnecessary-template-expressions] allow template expressions used to make trailing whitespace visible #10363

fix(eslint-plugin): [no-unnecessary-template-expressions] allow template expressions used to make trailing whitespace visible #10363

Uh oh!

kirkwaiblinger commented Nov 20, 2024 •

edited

Loading

Uh oh!

typescript-eslint bot commented Nov 20, 2024

Uh oh!

netlify bot commented Nov 20, 2024 •

edited

Loading

Uh oh!

nx-cloud bot commented Nov 20, 2024 •

edited

Loading

Uh oh!

codecov bot commented Nov 20, 2024 •

edited

Loading

Uh oh!

kirkwaiblinger Nov 20, 2024

Uh oh!

JoshuaKGoldberg left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix(eslint-plugin): [no-unnecessary-template-expressions] allow template expressions used to make trailing whitespace visible #10363

fix(eslint-plugin): [no-unnecessary-template-expressions] allow template expressions used to make trailing whitespace visible #10363

Uh oh!

Conversation

kirkwaiblinger commented Nov 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Checklist

Overview

Uh oh!

typescript-eslint bot commented Nov 20, 2024

Uh oh!

netlify bot commented Nov 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for typescript-eslint ready!

Uh oh!

nx-cloud bot commented Nov 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

☁️ Nx Cloud Report

Uh oh!

codecov bot commented Nov 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

kirkwaiblinger Nov 20, 2024

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

kirkwaiblinger commented Nov 20, 2024 •

edited

Loading

netlify bot commented Nov 20, 2024 •

edited

Loading

nx-cloud bot commented Nov 20, 2024 •

edited

Loading

codecov bot commented Nov 20, 2024 •

edited

Loading