Skip to content

docs(eslint-plugin): [no-base-to-string] correct documented default for ignoredTypeNames#12469

Merged
JoshuaKGoldberg merged 2 commits into
typescript-eslint:mainfrom
zaewc:docs/12463
Jul 1, 2026
Merged

docs(eslint-plugin): [no-base-to-string] correct documented default for ignoredTypeNames#12469
JoshuaKGoldberg merged 2 commits into
typescript-eslint:mainfrom
zaewc:docs/12463

Conversation

@zaewc

@zaewc zaewc commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

PR Checklist

Overview

The ignoredTypeNames section stated that { ignoredTypeNames: ["RegExp"] } was the default options, but the rule's actual default is ["Error", "RegExp", "URL", "URLSearchParams"]

Rather than duplicating the full default list in the prose, this removes the misleading "default" wording entirely, per the maintainer's suggestion in the issue - the correct default is already documented just above via the auto-inserted option description (Default: ["Error","RegExp","URL","URLSearchParams"])

@typescript-eslint

Copy link
Copy Markdown
Contributor

Thanks for the PR, @zaewc!

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

netlify Bot commented Jul 1, 2026

Copy link
Copy Markdown

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 37c9287
🔍 Latest deploy log https://app.netlify.com/projects/typescript-eslint/deploys/6a44b1bcda15ef00082a02f0
😎 Deploy Preview https://deploy-preview-12469--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 95 (🔴 down 4 from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 90 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@zaewc zaewc changed the title docs: update documentation for no-base-to-string rule to clarify opti… docs(eslint-plugin): [no-base-to-string] correct documented default for ignoredTypeNames Jul 1, 2026
@nx-cloud

nx-cloud Bot commented Jul 1, 2026

Copy link
Copy Markdown

View your CI Pipeline Execution ↗ for commit 76b4eec

Command Status Duration Result
nx run-many -t lint --projects=eslint-plugin --... ✅ Succeeded 56s View ↗
nx run-many -t lint --projects=typescript-estre... ✅ Succeeded 51s View ↗
nx run-many -t typecheck ✅ Succeeded 41s View ↗
nx run-many -t lint --projects=ast-spec,utils,s... ✅ Succeeded 30s View ↗
nx run-many -t typecheck:tsgo ✅ Succeeded 31s View ↗
nx run-many -t lint --projects=parser,type-util... ✅ Succeeded 25s View ↗
nx run integration-tests:test ✅ Succeeded 4s View ↗
nx run generate-configs ✅ Succeeded 6s View ↗
Additional runs (12) ✅ Succeeded ... View ↗

💡 Verify your cache is correct by running tasks in a sandbox. Read docs ↗


☁️ Nx Cloud last updated this comment at 2026-07-01 06:23:47 UTC

@codecov

codecov Bot commented Jul 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.74%. Comparing base (f5e00c4) to head (37c9287).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12469      +/-   ##
==========================================
+ Coverage   87.06%   94.74%   +7.68%     
==========================================
  Files         514      223     -291     
  Lines       16616    11426    -5190     
  Branches     5193     3809    -1384     
==========================================
- Hits        14467    10826    -3641     
+ Misses       1461      255    -1206     
+ Partials      688      345     -343     
Flag Coverage Δ
unittest 94.74% <ø> (+7.68%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 291 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.

Comment thread packages/eslint-plugin/docs/rules/no-base-to-string.mdx Outdated
@StyleShit StyleShit added the awaiting response Issues waiting for a reply from the OP or another party label Jul 1, 2026
@StyleShit StyleShit added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Jul 1, 2026
@StyleShit StyleShit enabled auto-merge (squash) July 1, 2026 06:29
@StyleShit StyleShit removed the awaiting response Issues waiting for a reply from the OP or another party label Jul 1, 2026
@JoshuaKGoldberg JoshuaKGoldberg disabled auto-merge July 1, 2026 12:04
@JoshuaKGoldberg JoshuaKGoldberg merged commit fb340aa into typescript-eslint:main Jul 1, 2026
45 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: [no-base-to-string] documented default for ignoredTypeNames is incorrect

3 participants