feat(eslint-plugin): [no-base-to-string] add checkUnknown Option #11128

developer-bandi · 2025-05-04T15:33:45Z

PR Checklist

Addresses an existing open issue: fixes Bug: [no-base-to-string] False negative for unknown type #10862
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

add checkUnknown option.

One thing I'm curious about is, is it correct to treat generic types as unknown?

function foo<T>(x: T) {
  String(x);
}

typescript-eslint · 2025-05-04T15:33:47Z

Thanks for the PR, @developer-bandi!

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 · 2025-05-04T15:34:04Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`80fd6d8`
🔍 Latest deploy log	https://app.netlify.com/projects/typescript-eslint/deploys/6842525cb1d7fd000893903b
😎 Deploy Preview	https://deploy-preview-11128--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.
Lighthouse	1 paths audited Performance: 98 (🔴 down 1 from production) Accessibility: 100 (no change from production) Best Practices: 100 (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 project configuration.

nx-cloud · 2025-05-04T15:34:37Z

View your CI Pipeline Execution ↗ for commit 80fd6d8.

Command	Status	Duration	Result
`nx test eslint-plugin --coverage=false`	✅ Succeeded	5m 1s	View ↗
`nx run-many -t typecheck`	✅ Succeeded	2m 9s	View ↗
`nx run-many -t lint`	✅ Succeeded	14s	View ↗
`nx run generate-configs`	✅ Succeeded	8s	View ↗
`nx test eslint-plugin-internal --coverage=false`	✅ Succeeded	<1s	View ↗
`nx run types:build`	✅ Succeeded	<1s	View ↗
`nx test typescript-estree --coverage=false`	✅ Succeeded	<1s	View ↗
`nx run integration-tests:test`	✅ Succeeded	<1s	View ↗
`Additional runs (27)`	✅ Succeeded	...	View ↗

☁️ Nx Cloud last updated this comment at 2025-06-06 02:39:48 UTC

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

JoshuaKGoldberg

LGTM, thanks!

Could you please get a passing CI so we can merge this though?

JoshuaKGoldberg

(wrong button)

codecov · 2025-05-18T13:52:11Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.91%. Comparing base (bca8a91) to head (80fd6d8).
Report is 86 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #11128      +/-   ##
==========================================
+ Coverage   90.84%   90.91%   +0.07%     
==========================================
  Files         497      501       +4     
  Lines       50320    50879     +559     
  Branches     8311     8385      +74     
==========================================
+ Hits        45714    46258     +544     
- Misses       4591     4606      +15     
  Partials       15       15

Flag	Coverage Δ
unittest	`90.91% <100.00%> (+0.07%)`	⬆️

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

... and 29 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

developer-bandi · 2025-05-18T14:01:19Z

LGTM, thanks!

Could you please get a passing CI so we can merge this though?

I added an option description to the document because there was an error that occurred not only in the CI error but also in the document due to not adding the option.

JoshuaKGoldberg

LGTM, thanks! 🚀

Just a couple small comment on the meta property, nothing we can't touch up before merge.

JoshuaKGoldberg · 2025-05-19T13:12:26Z

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

+            type: 'boolean',
+            default: false,
+            description:
+              'Checks the case where toString is applied to unknown type',


[Docs] A little bit of phrasing alignment:

Suggested change

'Checks the case where toString is applied to unknown type',

'Whether to also check values of type `unknown`',

JoshuaKGoldberg · 2025-05-19T13:13:52Z

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

@@ -46,6 +47,12 @@ export default createRule<Options, MessageIds>({
        type: 'object',
        additionalProperties: false,
        properties: {
+          checkUnknown: {
+            type: 'boolean',
+            default: false,


[Cleanup] This actually doesn't do anything in our stack (long story...)

Suggested change

default: false,

ronami

🚀🚀 Looking great, thank you! I've added a couple of comments around documentation and testing.

ronami · 2025-05-25T21:45:10Z

packages/eslint-plugin/docs/rules/no-base-to-string.mdx

+declare const x: unknown;
+x.toString();


[Docs] The example above already shows a type error (and so it's less likely to happen). What do you think about something along the following (similar to the one in the original issue):

declare const x: unknown; String(x);

I also think the above code is more suitable as an example. thank you.

ronami · 2025-05-25T21:54:42Z

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

      if (!toString) {
-        // e.g. any/unknown
+        // unknown
+        if (option.checkUnknown && type.flags === ts.TypeFlags.Unknown) {


[Tests] Removing type.flags === ts.TypeFlags.Unknown doesn't seem to fail any test, let's simplify or add a test case?

add any type test case. if we remove type.flags === ts.TypeFlags.Unknown, any type return Usefulness.Sometimes;

feat: add type and option

efb5f30

developer-bandi marked this pull request as draft May 4, 2025 15:33

feat: apply checkUnknown option and test case

d601fd3

developer-bandi marked this pull request as ready for review May 6, 2025 06:18

JoshuaKGoldberg changed the title ~~feat(eslint-plugin): [no-base-to-string] add restrictUnknown Option~~ feat(eslint-plugin): [no-base-to-string] add checkUnknown Option May 12, 2025

JoshuaKGoldberg reviewed May 12, 2025

View reviewed changes

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

JoshuaKGoldberg approved these changes May 12, 2025

View reviewed changes

JoshuaKGoldberg requested changes May 12, 2025

View reviewed changes

fix: ci error

3bdc647

developer-bandi requested a review from JoshuaKGoldberg May 18, 2025 14:01

JoshuaKGoldberg previously approved these changes May 19, 2025

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 May 19, 2025

ronami reviewed May 25, 2025

View reviewed changes

kirkwaiblinger added the awaiting response Issues waiting for a reply from the OP or another party label May 30, 2025

fix: change example code and add test cases

224b370

developer-bandi dismissed JoshuaKGoldberg’s stale review via 224b370 June 1, 2025 10:52

developer-bandi requested a review from ronami June 1, 2025 10:53

github-actions bot removed 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge awaiting response Issues waiting for a reply from the OP or another party labels Jun 1, 2025

developer-bandi added 2 commits June 3, 2025 22:43

fix: no-base-to-string Rule test fix and update schema

3ca5d85

fix: test config revert

80fd6d8

	'Checks the case where toString is applied to unknown type',
	'Whether to also check values of type `unknown`',

Uh oh!

feat(eslint-plugin): [no-base-to-string] add checkUnknown Option #11128

Are you sure you want to change the base?

feat(eslint-plugin): [no-base-to-string] add checkUnknown Option #11128

Uh oh!

Conversation

developer-bandi commented May 4, 2025 • edited by kirkwaiblinger Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Checklist

Overview

Uh oh!

typescript-eslint bot commented May 4, 2025

Uh oh!

netlify bot commented May 4, 2025 • 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 May 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

codecov bot commented May 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

developer-bandi commented May 18, 2025

Uh oh!

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg May 19, 2025

Choose a reason for hiding this comment

Uh oh!

JoshuaKGoldberg May 19, 2025

Choose a reason for hiding this comment

Uh oh!

ronami left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ronami May 25, 2025

Choose a reason for hiding this comment

Uh oh!

developer-bandi Jun 1, 2025

Choose a reason for hiding this comment

Uh oh!

ronami May 25, 2025

Choose a reason for hiding this comment

Uh oh!

developer-bandi Jun 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

developer-bandi commented May 4, 2025 •

edited by kirkwaiblinger

Loading

netlify bot commented May 4, 2025 •

edited

Loading

nx-cloud bot commented May 4, 2025 •

edited

Loading

codecov bot commented May 18, 2025 •

edited

Loading

ronami left a comment •

edited

Loading