Skip to content

docs: mention ESLint's defineConfig() #11335

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

JoshuaKGoldberg
Copy link
Member

PR Checklist

Overview

Adds an aside under Quickstart explaining the transient defineConfig() situation, along with a similar note under the typescript-eslint package docs.

I experimented for a bit splitting existing tseslint.config code blocks into tabs as suggested by the issue. That felt more confusing to me: that it was almost suggesting writing to files. Explaining the difference would have taken up even more previous docs space.

💖

@JoshuaKGoldberg JoshuaKGoldberg requested review from nzakas and a team June 23, 2025 17:31
@typescript-eslint
Copy link
Contributor

Thanks for the PR, @JoshuaKGoldberg!

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

netlify bot commented Jun 23, 2025

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 8dc5475
🔍 Latest deploy log https://app.netlify.com/projects/typescript-eslint/deploys/685be43e3f49440008094fa2
😎 Deploy Preview https://deploy-preview-11335--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: 98 (🟢 up 3 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (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.

Copy link

nx-cloud bot commented Jun 23, 2025

View your CI Pipeline Execution ↗ for commit 8dc5475.

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

☁️ Nx Cloud last updated this comment at 2025-06-25 12:08:43 UTC

Copy link

codecov bot commented Jun 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.84%. Comparing base (2e35e3a) to head (8dc5475).
Report is 7 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #11335   +/-   ##
=======================================
  Coverage   90.84%   90.84%           
=======================================
  Files         501      501           
  Lines       50911    50919    +8     
  Branches     8383     8387    +4     
=======================================
+ Hits        46248    46256    +8     
  Misses       4648     4648           
  Partials       15       15           
Flag Coverage Δ
unittest 90.84% <ø> (+<0.01%) ⬆️

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

see 1 file 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.

kirkwaiblinger
kirkwaiblinger previously approved these changes Jun 23, 2025
kirkwaiblinger
kirkwaiblinger previously approved these changes Jun 23, 2025
@kirkwaiblinger 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 Jun 23, 2025
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
kirkwaiblinger
kirkwaiblinger previously approved these changes Jun 24, 2025
Co-authored-by: Kirk Waiblinger <53019676+kirkwaiblinger@users.noreply.github.com>
Copy link
Contributor

@nzakas nzakas left a comment

Choose a reason for hiding this comment

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

LGTM.

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: Mention ESLint's defineConfig (until tseslint.config is deprecated)
3 participants
pFad - Phonifier reborn

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

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy