typescript-eslint/typescript-eslintPublic

NotificationsYou must be signed in to change notification settings
Fork2.8k
Star16k

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

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

JoshuaKGoldberg merged 5 commits intotypescript-eslint:mainfromkirkwaiblinger:necessary-template-expressions

Nov 26, 2024

Merged

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

JoshuaKGoldberg merged 5 commits intotypescript-eslint:mainfromkirkwaiblinger:necessary-template-expressions

Nov 26, 2024

Conversation

Copy link

Member

kirkwaiblinger commentedNov 20, 2024•
edited
Loading

PR Checklist

Addresses an existing open issue:fixesBug: [no-unnecessary-template-expression] do not flag multiline template strings that interpolate trailing whitespace #10360
That issue was marked asaccepting prs
Steps inContributing 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

🫡

kirkwaiblinger added3 commits

November 20, 2024 00:40

whitespace is useful

5597d6d

no-longer-needed-disable

7d5f82e

windows stuff and template cov

b59f684

Copy link

Contributor

typescript-eslintbot commentedNov 20, 2024

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.

Copy link

netlifybot commentedNov 20, 2024•
edited
Loading

✅ Deploy Preview fortypescript-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 yourNetlify site configuration.

remove duplicate test case

35194ee

Copy link

nx-cloudbot commentedNov 20, 2024•
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit48a1c0e. 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 💌 fromNxCloud.

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

Copy link

codecovbot commentedNov 20, 2024•
edited
Loading

Codecov Report

Attention: Patch coverage is94.73684% with1 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%)`	⬇️

tweaks

48a1c0e

kirkwaiblinger marked this pull request as ready for review

November 20, 2024 17:49

kirkwaiblinger commented

Nov 20, 2024

View reviewed changes

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

		`,
		],
		invalid:[
		/* eslint-disable @typescript-eslint/no-unnecessary-template-expression -- trailing whitespace */

Copy link

MemberAuthor

kirkwaiblingerNov 20, 2024

Choose a reason for hiding this comment

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

🙂

JoshuaKGoldberg approved these changes

Nov 22, 2024

View reviewed changes

Copy link

Member

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

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

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 commitfcd6cf0 intotypescript-eslint:main

Nov 26, 2024

79 checks passed

kirkwaiblinger deleted the necessary-template-expressions branch

November 27, 2024 01:51

renovatebot added a commit to mmkal/eslint-plugin-mmkal that referenced this pull request

Dec 2, 2024

fix(deps): update typescript-eslint monorepo to v8.17.0

cfe1395

##### [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 AmielYou 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.

renovatebot added a commit to mmkal/eslint-plugin-mmkal that referenced this pull request

Dec 2, 2024

fix(deps): update typescript-eslint monorepo to v8.17.0

c381fc1

##### [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 AmielYou 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.

renovatebot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request

Dec 3, 2024

Update typescript-eslint monorepo to v8.17.0

d41dde8

| 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 AmielYou 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.

renovatebot added a commit to andrei-picus-tink/auto-renovate that referenced this pull request

Dec 3, 2024

Update typescript-eslint monorepo to v8.17.0

5ed9332

| 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 AmielYou 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.

github-actionsbot locked asresolvedand limited conversation to collaborators

Dec 13, 2024

Labels

1 approval

>=1 team member has approved this PR; we're now leaving it open for more reviews before we merge

Movatterモバイル変換

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 commentedNov 20, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

PR Checklist

Overview

Uh oh!

typescript-eslintbot commentedNov 20, 2024

Uh oh!

netlifybot commentedNov 20, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

✅ Deploy Preview fortypescript-eslint ready!

Uh oh!

nx-cloudbot commentedNov 20, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

☁️ Nx Cloud Report

Uh oh!

codecovbot commentedNov 20, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Codecov Report

Uh oh!

kirkwaiblingerNov 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kirkwaiblinger commentedNov 20, 2024•
edited
Loading

netlifybot commentedNov 20, 2024•
edited
Loading

nx-cloudbot commentedNov 20, 2024•
edited
Loading

codecovbot commentedNov 20, 2024•
edited
Loading