Skip to content

feat(typescript-estree): infer tsconfigRootDir from call stack #11370

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
JoshuaKGoldberg merged 17 commits into from
Jul 14, 2025
Merged

feat(typescript-estree): infer tsconfigRootDir from call stack #11370

JoshuaKGoldberg merged 17 commits into from
Jul 14, 2025

Conversation

@JoshuaKGoldberg
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg commented Jul 3, 2025 •
edited
Loading

PR Checklist

Overview

Adds a trio of logical pieces:

  1. candidateTSConfigRootDirs: stores candidate root directories inside typescript-estree, exposed via add*, clear*, and get* functions
    • The get*, getInferredTSConfigRootDir, will throw an error if multiple candidates have been populated. It's only called by createParseSettings if no tsconfigRootDir was explicitly provided.
  2. getTSConfigRootDirFromStack: given a call stack, gets the candidate directory hosting an ESLint config file -- if it can be found
  3. createConfigsGetters: wraps the configs in typescript-eslint with getters that pass the result of getRootDirFromStack to candidateTSConfigRootDirs

The result is that using any configs like tseslint.configs.recommendedTypeChecked will attempt to populate a candidate tsconfigRootDir for parse settings.

💖

@typescript-eslint
Copy link
Contributor

typescript-eslint bot commented Jul 3, 2025

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.

@netlify
Copy link

netlify bot commented Jul 3, 2025 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 718b881
🔍 Latest deploy log https://app.netlify.com/projects/typescript-eslint/deploys/686eeed8b40e270008afc7d6
😎 Deploy Preview https://deploy-preview-11370--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: 86 (🔴 down 3 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.

JoshuaKGoldberg
JoshuaKGoldberg commented Jul 3, 2025
View reviewed changes
@nx-cloud
Copy link

nx-cloud bot commented Jul 3, 2025 •
edited
Loading

View your CI Pipeline Execution ↗ for commit 718b881

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

☁️ Nx Cloud last updated this comment at 2025-07-09 22:47:39 UTC

JoshuaKGoldberg
JoshuaKGoldberg commented Jul 3, 2025
View reviewed changes
JoshuaKGoldberg
JoshuaKGoldberg commented Jul 3, 2025
View reviewed changes
@codecov
Copy link

codecov bot commented Jul 4, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.86%. Comparing base (16c344e) to head (718b881).
Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main   #11370   +/-   ##
=======================================
  Coverage   90.85%   90.86%           
=======================================
  Files         501      503    +2     
  Lines       50987    51028   +41     
  Branches     8410     8421   +11     
=======================================
+ Hits        46324    46365   +41     
  Misses       4648     4648           
  Partials       15       15
Flag Coverage Δ
unittest 90.86% <100.00%> (+<0.01%) ⬆️

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

Files with missing lines Coverage Δ
...pescript-eslint/src/getTSConfigRootDirFromStack.ts 100.00% <100.00%> (ø)
packages/typescript-estree/src/clear-caches.ts 100.00% <100.00%> (ø)
...ree/src/parseSettings/candidateTSConfigRootDirs.ts 100.00% <100.00%> (ø)
...pt-estree/src/parseSettings/createParseSettings.ts 92.18% <100.00%> (+0.04%) ⬆️
🚀 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.

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review July 4, 2025 14:11
@JoshuaKGoldberg JoshuaKGoldberg requested a review from a team July 4, 2025 14:11
bradzacher
bradzacher previously approved these changes Jul 9, 2025
View reviewed changes
packages/typescript-eslint/src/index.ts

import pluginBase from '@typescript-eslint/eslint-plugin';
import rawPlugin from '@typescript-eslint/eslint-plugin/use-at-your-own-risk/raw-plugin';
import { addCandidateTSConfigRootDir } from '@typescript-eslint/typescript-estree';
Copy link
Member

@bradzacher bradzacher Jul 9, 2025

Choose a reason for hiding this comment

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

this adds dependency on a transitive dep -- which will break consumers.
the dep needs to be listed in the package.json

there's something with our lint config -- there should be like import/no-extraneous-deps or something that's covering this.

Copy link
Member Author

@JoshuaKGoldberg JoshuaKGoldberg Jul 9, 2025

Choose a reason for hiding this comment

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

I think import-x would have caught this 😄

@JoshuaKGoldberg JoshuaKGoldberg merged commit 7126c3a into typescript-eslint:main Jul 14, 2025
64 checks passed
@JoshuaKGoldberg JoshuaKGoldberg deleted the infer-tsconfigrootdir-candidates branch July 14, 2025 11:37
@matthew-plusprogramming matthew-plusprogramming mentioned this pull request Jul 15, 2025
Closed
4 tasks
@joshbwlng joshbwlng mentioned this pull request Jul 15, 2025
Merged
@chabb chabb mentioned this pull request Jul 15, 2025
Closed
4 tasks
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 22, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@bradzacher bradzacher bradzacher approved these changes

@kirkwaiblinger kirkwaiblinger Awaiting requested review from kirkwaiblinger

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Enhancement: Default tsconfigRootDir to the running flat config's directory if available

2 participants

@JoshuaKGoldberg @bradzacher