Skip to content

feat: deprecate tseslint.config() #11531

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 14 commits into from
Sep 1, 2025
Merged

feat: deprecate tseslint.config() #11531

merged 14 commits into from
Sep 1, 2025

Conversation

@kirkwaiblinger
Copy link
Member

@kirkwaiblinger kirkwaiblinger commented Aug 26, 2025 •
edited
Loading

Important

If you've come across this PR looking for info on migrating off of tseslint.config(), please see https://typescript-eslint.io/packages/typescript-eslint#migrating-to-defineconfig

PR Checklist

Overview

  • Replaces tseslint.config() in the docs everywhere with defineConfig()
  • adds /** @deprecated */ to tseslint.config().
  • adds deprecation/migration info to the docs.
  • switches our eslint config to use defineConfig()

Questions

  • Should we use the defineConfig(a, b, c) or defineConfig([a, b, c]) style? The eslint docs (inexplicably) use defineConfig([a, b, c]) throughout, but defineConfig(a, b, c) is much better in a TS context since each argument's type is checked individually. I've gone with that approach for now, but we can change to match their style if we want.

@typescript-eslint
Copy link
Contributor

typescript-eslint bot commented Aug 26, 2025

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
Copy link

netlify bot commented Aug 26, 2025 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 1576c1f
🔍 Latest deploy log https://app.netlify.com/projects/typescript-eslint/deploys/68b52f48176ffd0008b877c8
😎 Deploy Preview https://deploy-preview-11531--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: 82 (🔴 down 15 from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (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
Copy link

nx-cloud bot commented Aug 26, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 1576c1f

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

☁️ Nx Cloud last updated this comment at 2025-09-01 05:35:32 UTC

@kirkwaiblinger kirkwaiblinger changed the title docs: deprecate tseslint.config() feat: deprecate tseslint.config() Aug 27, 2025
@kirkwaiblinger kirkwaiblinger marked this pull request as ready for review August 27, 2025 17:28
JoshuaKGoldberg
JoshuaKGoldberg reviewed Aug 27, 2025
View reviewed changes
JoshuaKGoldberg
JoshuaKGoldberg previously approved these changes Aug 27, 2025
View reviewed changes
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Always nice to see a formatter issue filed as a result of docs work 😅

Great stuff!

@kirkwaiblinger @JoshuaKGoldberg
Update docs/getting-started/Quickstart.mdx
ce6cda6 
Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
@kirkwaiblinger @JoshuaKGoldberg
Update docs/packages/TypeScript_ESLint.mdx
18a76fc 
Co-authored-by: Josh Goldberg ✨ <git@joshuakgoldberg.com>
Josh-Cena
Josh-Cena approved these changes Aug 28, 2025
View reviewed changes
Copy link
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

LGTM

@Josh-Cena Josh-Cena added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Aug 28, 2025
@kachkaev kachkaev mentioned this pull request Aug 28, 2025
Closed
@kirkwaiblinger kirkwaiblinger enabled auto-merge (squash) September 1, 2025 05:29
@kirkwaiblinger kirkwaiblinger merged commit d7614a7 into typescript-eslint:main Sep 1, 2025
63 checks passed
@kirkwaiblinger kirkwaiblinger deleted the deprecate-tseslint-config branch September 1, 2025 15:22
@chrisbbreuer chrisbbreuer mentioned this pull request Sep 2, 2025
Closed
@stefanprobst
Copy link

stefanprobst commented Sep 2, 2025 •
edited
Loading

is the ConfigWithExtends type available publicly?

@stevezhu stevezhu mentioned this pull request Sep 3, 2025
Merged
stevezhu added a commit to stevezhu/eslint-config that referenced this pull request Sep 3, 2025
@stevezhu
Re-export eslint/config exports (#44)
01180a7 
typescript-eslint/typescript-eslint#10935
typescript-eslint/typescript-eslint#11531
@corneliusroemer
Copy link

corneliusroemer commented Sep 4, 2025

Migration guide for deprecated tseslint.config() -> defineConfig: https://typescript-eslint.io/packages/typescript-eslint/#migrating-to-defineconfig

@kirkwaiblinger
Copy link
Member Author

kirkwaiblinger commented Sep 4, 2025

@stefanprobst

is the ConfigWithExtends type available publicly?

This isn't directly related to this PR, and we anyways try to avoid commenting on closed PRs (docs). Would you mind reaching out to us with one of the methods in the contributing guide to continue the conversation?

Thanks!

@typescript-eslint typescript-eslint locked as resolved and limited conversation to collaborators Sep 4, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@Josh-Cena Josh-Cena Josh-Cena approved these changes

@JoshuaKGoldberg JoshuaKGoldberg Awaiting requested review from JoshuaKGoldberg

Assignees

No one assigned

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

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Docs: Mention defineConfig(); remove mention of tseslint.config()

5 participants

@kirkwaiblinger @stefanprobst @corneliusroemer @JoshuaKGoldberg @Josh-Cena