fix(eslint-plugin): [no-base-to-string] check array generic type #10437

ronami · 2024-12-01T21:04:29Z

PR Checklist

Addresses an existing open issue: fixes Bug: [no-base-to-string] check array generic type #10430
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

This PR addresses #10430 and adjusts the rule so it reports on the following ways of stringifying arrays (to my understanding, all are effectively the same as calling array.join('')):

// '[object Object],[object Object]'
String([{}, {}]);

// '[object Object],[object Object]'
`${[{}, {}]}`;

// '[object Object],[object Object]'
[{}, {}].toString();

Note that only the first (string coercion) is mentioned on the original issue, but it made sense to support the other ones too.

typescript-eslint · 2024-12-01T21:04:32Z

Thanks for the PR, @ronami!

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-01T21:04:48Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`5ebba43`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6772e202ca061e0008481ed0
😎 Deploy Preview	https://deploy-preview-10437--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 8 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-01T21:05:22Z

View your CI Pipeline Execution ↗ for commit 5ebba43.

Command	Status	Duration	Result
`nx run-many --target=build --exclude website --...`	✅ Succeeded	2s	View ↗
`nx run-many --target=clean`	✅ Succeeded	10s	View ↗

☁️ Nx Cloud last updated this comment at 2024-12-30 18:48:49 UTC

codecov · 2024-12-01T21:31:39Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.90%. Comparing base (24a1510) to head (5ebba43).
Report is 56 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #10437      +/-   ##
==========================================
+ Coverage   86.77%   86.90%   +0.13%     
==========================================
  Files         444      446       +2     
  Lines       15335    15506     +171     
  Branches     4468     4518      +50     
==========================================
+ Hits        13307    13476     +169     
- Misses       1673     1675       +2     
  Partials      355      355

Flag	Coverage Δ
unittest	`86.90% <100.00%> (+0.13%)`	⬆️

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	`97.05% <100.00%> (+0.18%)`	⬆️

... and 29 files with indirect coverage changes

…ck-array-type

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

JoshuaKGoldberg

What Kirk said ✨

kirkwaiblinger

(leaving a review in order for the label automations to work right)

… faulty tests to not check against the {} type

kirkwaiblinger

One question, otherwise looks great to me!

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

kirkwaiblinger

JoshuaKGoldberg

So many tests! 🙌

…escript-eslint#10437) * initial implementation * add missing test * undo unrelated change * also cover [].toString() * refactor * respect the ignoredTypeNames option * update existing tests to use a helper for checking arrays, and change faulty tests to not check against the {} type * don't use a test helper for creating tests dynamically * remove unnecessary check

@y-hsgw

##### [v8.19.1](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8191-2025-01-06) ##### 🩹 Fixes - **eslint-plugin:** \[no-unnecessary-type-assertion] handle literal types ([#10523](typescript-eslint/typescript-eslint#10523)) - **eslint-plugin:** \[no-deprecated] doesn't report on shorthand property in an object expression ([#10550](typescript-eslint/typescript-eslint#10550)) - **eslint-plugin:** \[strict-boolean-expressions] remove remaining (unsafe) autofixes ([#10548](typescript-eslint/typescript-eslint#10548)) - **eslint-plugin:** \[no-shadow] report correctly on parameters of functions declared with the `declare` keyword ([#10543](typescript-eslint/typescript-eslint#10543)) - **eslint-plugin:** \[no-base-to-string] check array generic type ([#10437](typescript-eslint/typescript-eslint#10437)) ##### ❤️ Thank You - Kirk Waiblinger - mdm317 - Ronen Amiel - Yukihiro Hasegawa [@y-hsgw](https://github.com/y-hsgw) 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.

@y-hsgw

| datasource | package | from | to | | ---------- | -------------------------------- | ------ | ------ | | npm | @typescript-eslint/eslint-plugin | 8.19.0 | 8.19.1 | | npm | @typescript-eslint/parser | 8.19.0 | 8.19.1 | ## [v8.19.1](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#8191-2025-01-06) ##### 🩹 Fixes - **eslint-plugin:** \[no-unnecessary-type-assertion] handle literal types ([#10523](typescript-eslint/typescript-eslint#10523)) - **eslint-plugin:** \[no-deprecated] doesn't report on shorthand property in an object expression ([#10550](typescript-eslint/typescript-eslint#10550)) - **eslint-plugin:** \[strict-boolean-expressions] remove remaining (unsafe) autofixes ([#10548](typescript-eslint/typescript-eslint#10548)) - **eslint-plugin:** \[no-shadow] report correctly on parameters of functions declared with the `declare` keyword ([#10543](typescript-eslint/typescript-eslint#10543)) - **eslint-plugin:** \[no-base-to-string] check array generic type ([#10437](typescript-eslint/typescript-eslint#10437)) ##### ❤️ Thank You - Kirk Waiblinger - mdm317 - Ronen Amiel - Yukihiro Hasegawa [@y-hsgw](https://github.com/y-hsgw) 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.

initial implementation

1052e4c

ronami force-pushed the no-base-to-string-check-array-type branch from 694ada9 to 1052e4c Compare December 1, 2024 21:09

add missing test

93a83e2

ronami added 2 commits December 1, 2024 23:43

undo unrelated change

a13cfcf

also cover [].toString()

9ed7c53

ronami marked this pull request as ready for review December 1, 2024 22:19

ronami marked this pull request as draft December 1, 2024 22:54

refactor

2b85f4d

ronami marked this pull request as ready for review December 2, 2024 16:37

Merge remote-tracking branch 'origin/main' into no-base-to-string-che…

d2e2917

…ck-array-type

kirkwaiblinger reviewed Dec 14, 2024

View reviewed changes

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

packages/eslint-plugin/tests/rules/no-base-to-string.test.ts Outdated Show resolved Hide resolved

JoshuaKGoldberg requested changes Dec 14, 2024

View reviewed changes

JoshuaKGoldberg added the awaiting response Issues waiting for a reply from the OP or another party label Dec 14, 2024

respect the ignoredTypeNames option

07c59ca

ronami requested a review from kirkwaiblinger December 15, 2024 19:55

github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Dec 15, 2024

kirkwaiblinger reviewed Dec 17, 2024

View reviewed changes

kirkwaiblinger added the awaiting response Issues waiting for a reply from the OP or another party label Dec 17, 2024

update existing tests to use a helper for checking arrays, and change…

0bc1024

… faulty tests to not check against the {} type

ronami requested review from JoshuaKGoldberg and kirkwaiblinger December 18, 2024 12:14

github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Dec 18, 2024

don't use a test helper for creating tests dynamically

2fc6c6c

kirkwaiblinger reviewed Dec 28, 2024

View reviewed changes

packages/eslint-plugin/src/rules/no-base-to-string.ts Outdated Show resolved Hide resolved

kirkwaiblinger added the awaiting response Issues waiting for a reply from the OP or another party label Dec 28, 2024

remove unnecessary check

5ebba43

ronami requested a review from kirkwaiblinger December 30, 2024 18:28

github-actions bot removed the awaiting response Issues waiting for a reply from the OP or another party label Dec 30, 2024

kirkwaiblinger approved these changes Dec 30, 2024

View reviewed changes

kirkwaiblinger 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 30, 2024

JoshuaKGoldberg approved these changes Dec 30, 2024

View reviewed changes

JoshuaKGoldberg merged commit c27399b into typescript-eslint:main Dec 30, 2024
62 of 65 checks passed

ronami deleted the no-base-to-string-check-array-type branch December 30, 2024 19:03

github-actions bot locked as resolved and limited conversation to collaborators Jan 7, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(eslint-plugin): [no-base-to-string] check array generic type #10437

fix(eslint-plugin): [no-base-to-string] check array generic type #10437

ronami commented Dec 1, 2024 •

edited

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

JoshuaKGoldberg left a comment

kirkwaiblinger left a comment

kirkwaiblinger left a comment

kirkwaiblinger left a comment

JoshuaKGoldberg left a comment

fix(eslint-plugin): [no-base-to-string] check array generic type #10437

fix(eslint-plugin): [no-base-to-string] check array generic type #10437

Conversation

ronami commented Dec 1, 2024 • edited 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

codecov bot commented Dec 1, 2024 • edited Loading

Codecov Report

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

kirkwaiblinger left a comment

Choose a reason for hiding this comment

kirkwaiblinger left a comment

Choose a reason for hiding this comment

kirkwaiblinger left a comment

Choose a reason for hiding this comment

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

ronami commented Dec 1, 2024 •

edited

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