fix(eslint-plugin): [no-base-to-string] handle more robustly when multiple `toString()` declarations are present for a type #10432

kirkwaiblinger · 2024-12-01T03:40:19Z

PR Checklist

Addresses an existing open issue:
- fixes Repo: [no-base-to-string] remove nonsensical spread element test cases #10431 - ~~⌛ not yet accepting PRs~~ ✅
- fixes Bug: [no-base-to-string] intersection of safe object and plain object considered maybe-unsafe #8585 - ✅ accepting PRs
Steps in Contributing were taken

Overview

#8585 only repros in TS < 5.4, so you'll want to use the branch playground to verify that the repro in the issue is actually fixed for TS < 5.4.

In short - we want to apply the heuristic that if more than one toString() declaration is present for a type, it must be useful. However - there are multiple reasons that multiple toString() declarations may be present. Therefore, we need to be much more careful about handling intersections and generics, lest we erroneously apply the multiple-declaration heuristic to cases it does not apply.

This is all tested for, except, ironically, for the actual repro in the issue, since that requires TS < 5.4, and I don't think we have infra for testing that. Regardless, as said, you can see it working in the branch sandbox

typescript-eslint · 2024-12-01T03:40:21Z

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-12-01T03:40:35Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`f323fdc`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/674c0dd391f0e50008f00714
😎 Deploy Preview	https://deploy-preview-10432--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 6 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-12-01T03:41:14Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit f323fdc. 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 1 target

nx run-many --target=clean

Sent with 💌 from NxCloud.

codecov · 2024-12-01T03:56:13Z

Codecov Report

Attention: Patch coverage is 88.23529% with 2 lines in your changes missing coverage. Please review.

Project coverage is 86.75%. Comparing base (05617d2) to head (f323fdc).
Report is 14 commits behind head on main.

Files with missing lines	Patch %	Lines
...kages/eslint-plugin/src/rules/no-base-to-string.ts	88.23%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #10432      +/-   ##
==========================================
- Coverage   86.75%   86.75%   -0.01%     
==========================================
  Files         443      443              
  Lines       15302    15309       +7     
  Branches     4454     4457       +3     
==========================================
+ Hits        13276    13281       +5     
- Misses       1672     1673       +1     
- Partials      354      355       +1

Flag	Coverage Δ
unittest	`86.75% <88.23%> (-0.01%)`	⬇️

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

Files with missing lines	Coverage Δ
...kages/eslint-plugin/src/rules/no-base-to-string.ts	`96.87% <88.23%> (-2.01%)`	⬇️

kirkwaiblinger · 2024-12-01T04:16:43Z

packages/eslint-plugin/tests/rules/no-base-to-string.test.ts

+declare const bb: ExtendedGuildChannel;
+bb.toString();
+    `,
+    // https://github.com/typescript-eslint/typescript-eslint/issues/8585 with intersection order reversed.


Why is this relevant, you might ask? Because it affects the order in which the overloads are declared (and therefore resolved), at least for TS < 5.4.

(playground)

type Constructable<Entity> = abstract new (...args: any[]) => Entity; interface GuildChannel { toString(): `<#${string}>`; } declare const foo: Constructable<GuildChannel & { bar: 1 }>; class ExtendedGuildChannel extends foo {} declare const bb: ExtendedGuildChannel; bb.toString() satisfies `<#${string}>`;

but this errors
(playground)

type Constructable<Entity> = abstract new (...args: any[]) => Entity; interface GuildChannel { toString(): `<#${string}>`; } declare const foo: Constructable<{ bar: 1 } & GuildChannel>; class ExtendedGuildChannel extends foo {} declare const bb: ExtendedGuildChannel; bb.toString() satisfies `<#${string}>`;

kirkwaiblinger · 2024-12-01T05:44:24Z

packages/eslint-plugin/tests/rules/no-base-to-string.test.ts

@@ -682,13 +703,63 @@ declare const foo: Bar & Foo;
      errors: [
        {
          data: {
-            certainty: 'will',
+            certainty: 'may',


this is just an existing bug of imprecise handling of generics.

JoshuaKGoldberg

Nice 😄

@developer-bandi

##### [v8.18.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8180-2024-12-09) ##### 🚀 Features - **eslint-plugin:** \[switch-exhaustiveness-check] add support for "no default" comment ([#10218](typescript-eslint/typescript-eslint#10218)) - **eslint-plugin:** \[no-deprecated] report on super call of deprecated constructor ([#10397](typescript-eslint/typescript-eslint#10397)) ##### 🩹 Fixes - **eslint-plugin:** \[use-unknown-in-catch-callback-variable] only flag function literals ([#10436](typescript-eslint/typescript-eslint#10436)) - **eslint-plugin:** \[no-base-to-string] handle more robustly when multiple `toString()` declarations are present for a type ([#10432](typescript-eslint/typescript-eslint#10432)) - **eslint-plugin:** \[no-deprecated] check if a JSX attribute is deprecated ([#10374](typescript-eslint/typescript-eslint#10374)) - typescript peer dependency ([#10373](typescript-eslint/typescript-eslint#10373)) ##### ❤️ Thank You - Kim Sang Du [@developer-bandi](https://github.com/developer-bandi) - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) - mdm317 - rtritto 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.

@developer-bandi

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.17.0 | 8.18.0 | | npm | @typescript-eslint/parser | 8.17.0 | 8.18.0 | ## [v8.18.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8180-2024-12-09) ##### 🚀 Features - **eslint-plugin:** \[switch-exhaustiveness-check] add support for "no default" comment ([#10218](typescript-eslint/typescript-eslint#10218)) - **eslint-plugin:** \[no-deprecated] report on super call of deprecated constructor ([#10397](typescript-eslint/typescript-eslint#10397)) ##### 🩹 Fixes - **eslint-plugin:** \[use-unknown-in-catch-callback-variable] only flag function literals ([#10436](typescript-eslint/typescript-eslint#10436)) - **eslint-plugin:** \[no-base-to-string] handle more robustly when multiple `toString()` declarations are present for a type ([#10432](typescript-eslint/typescript-eslint#10432)) - **eslint-plugin:** \[no-deprecated] check if a JSX attribute is deprecated ([#10374](typescript-eslint/typescript-eslint#10374)) - typescript peer dependency ([#10373](typescript-eslint/typescript-eslint#10373)) ##### ❤️ Thank You - Kim Sang Du [@developer-bandi](https://github.com/developer-bandi) - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) - mdm317 - rtritto 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.

@developer-bandi

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.17.0 | 8.18.0 | | npm | @typescript-eslint/parser | 8.17.0 | 8.18.0 | ## [v8.18.0](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8180-2024-12-09) ##### 🚀 Features - **eslint-plugin:** \[switch-exhaustiveness-check] add support for "no default" comment ([#10218](typescript-eslint/typescript-eslint#10218)) - **eslint-plugin:** \[no-deprecated] report on super call of deprecated constructor ([#10397](typescript-eslint/typescript-eslint#10397)) ##### 🩹 Fixes - **eslint-plugin:** \[use-unknown-in-catch-callback-variable] only flag function literals ([#10436](typescript-eslint/typescript-eslint#10436)) - **eslint-plugin:** \[no-base-to-string] handle more robustly when multiple `toString()` declarations are present for a type ([#10432](typescript-eslint/typescript-eslint#10432)) - **eslint-plugin:** \[no-deprecated] check if a JSX attribute is deprecated ([#10374](typescript-eslint/typescript-eslint#10374)) - typescript peer dependency ([#10373](typescript-eslint/typescript-eslint#10373)) ##### ❤️ Thank You - Kim Sang Du [@developer-bandi](https://github.com/developer-bandi) - Kirk Waiblinger [@kirkwaiblinger](https://github.com/kirkwaiblinger) - mdm317 - rtritto 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.

remove confusing spread element test cases

e224e60

kirkwaiblinger added 3 commits November 30, 2024 21:04

fix intersection checking

1fc3f23

fix for old versions of TS

01f6a24

lintfix

132bb4f

kirkwaiblinger changed the title ~~fix(eslint-plugin): [no-base-to-string] remove confusing spread element test cases~~ fix(eslint-plugin): [no-base-to-string] handle more robustly when multiple toString() declarations are present for a type Dec 1, 2024

kirkwaiblinger marked this pull request as ready for review December 1, 2024 05:47

kirkwaiblinger commented Dec 1, 2024

View reviewed changes

kirkwaiblinger mentioned this pull request Dec 1, 2024

Bug: [no-base-to-string] intersection of safe object and plain object considered maybe-unsafe #8585

Closed

4 tasks

kirkwaiblinger added 5 commits November 30, 2024 22:55

readability

2309fe3

isTypeParameter comment

d2b7ca7

derp

2a943bd

ignored types

dfd3b70

expression

f323fdc

JoshuaKGoldberg approved these changes Dec 7, 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 Dec 7, 2024

JoshuaKGoldberg merged commit 24a1510 into typescript-eslint:main Dec 7, 2024
67 of 70 checks passed

kirkwaiblinger deleted the spread-element branch December 7, 2024 16:50

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(eslint-plugin): [no-base-to-string] handle more robustly when multiple `toString()` declarations are present for a type #10432

fix(eslint-plugin): [no-base-to-string] handle more robustly when multiple `toString()` declarations are present for a type #10432

kirkwaiblinger commented Dec 1, 2024 •

edited by JoshuaKGoldberg

Loading

typescript-eslint bot commented Dec 1, 2024

netlify bot commented Dec 1, 2024 •

edited

Loading

nx-cloud bot commented Dec 1, 2024 •

edited

Loading

codecov bot commented Dec 1, 2024 •

edited

Loading

kirkwaiblinger Dec 1, 2024

kirkwaiblinger Dec 1, 2024

JoshuaKGoldberg left a comment

fix(eslint-plugin): [no-base-to-string] handle more robustly when multiple toString() declarations are present for a type #10432

fix(eslint-plugin): [no-base-to-string] handle more robustly when multiple toString() declarations are present for a type #10432

Conversation

kirkwaiblinger commented Dec 1, 2024 • edited by JoshuaKGoldberg Loading

PR Checklist

Overview

typescript-eslint bot commented Dec 1, 2024

netlify bot commented Dec 1, 2024 • edited Loading

✅ Deploy Preview for typescript-eslint ready!

nx-cloud bot commented Dec 1, 2024 • edited Loading

☁️ Nx Cloud Report

codecov bot commented Dec 1, 2024 • edited Loading

Codecov Report

kirkwaiblinger Dec 1, 2024

Choose a reason for hiding this comment

kirkwaiblinger Dec 1, 2024

Choose a reason for hiding this comment

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

fix(eslint-plugin): [no-base-to-string] handle more robustly when multiple `toString()` declarations are present for a type #10432

fix(eslint-plugin): [no-base-to-string] handle more robustly when multiple `toString()` declarations are present for a type #10432

kirkwaiblinger commented Dec 1, 2024 •

edited by JoshuaKGoldberg

Loading

netlify bot commented Dec 1, 2024 •

edited

Loading

nx-cloud bot commented Dec 1, 2024 •

edited

Loading

codecov bot commented Dec 1, 2024 •

edited

Loading