feat(typescript-estree): clarify docs and error for program project without matching TSConfig

[JoshuaKGoldberg]

PR Checklist

• Addresses an existing open issue: fixes Docs: Improve error message & docs for "The file does not match your project config" #5753
• That issue was marked as accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

This PR does three things:

• It changes the error message from @typescript-eslint/typescript-estree -as called by @typescript-eslint/parser when parserOptions.program is specified but no TSConfig includes the file being linted. Now, the error message is much more clear on what's going on, and what some suggested remediations & further docs reading are
• It clarifies & expands the initial context mentioned in the docs
• It moves those docs from Typed Linting FAQs to the general troubleshooting page
  • I'm not 100% on this, and might be changing my opinion from several months ago... but my current hunch is that it'd be good to have all FAQs in one place

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 73e875f. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

---

✅ Successfully ran 46 targets

• Node 14 - nx test @typescript-eslint/eslint-plugin --coverage=false
• Node 18 - nx test @typescript-eslint/eslint-plugin
• Node 18 - nx test @typescript-eslint/typescript-estree
• Node 14 - nx test @typescript-eslint/typescript-estree --coverage=false
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/type-utils
• Node 18 - nx test @typescript-eslint/visitor-keys
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/utils
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/scope-manager
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=typecheck --all --parallel
• Node 18 - nx test @typescript-eslint/parser
• Node 18 - nx test @typescript-eslint/eslint-plugin-tslint
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/scope-manager --coverage=false
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/type-utils --coverage=false
• Node 14 - nx test @typescript-eslint/utils --coverage=false
• Node 14 - nx test @typescript-eslint/visitor-keys --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/ast-spec
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/parser --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/eslint-plugin-internal
• Node 14 - nx test @typescript-eslint/eslint-plugin-internal --coverage=false
• Node 14 - nx test @typescript-eslint/eslint-plugin-tslint --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/ast-spec --coverage=false
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website

---

Sent with 💌 from NxCloud.

[typescript-eslint]

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. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

[netlify]

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	73e875f
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/635703b0652449000800d91f
😎 Deploy Preview	https://deploy-preview-5762--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[codecov]

Codecov Report

Merging #5762 (def07d6) into main (1eaae09) will decrease coverage by 0.00%.
The diff coverage is 90.90%.

❗ Current head def07d6 differs from pull request most recent head 73e875f. Consider uploading reports for the commit 73e875f to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5762      +/-   ##
==========================================
- Coverage   91.33%   91.32%   -0.01%     
==========================================
  Files         361      361              
  Lines       12033    12041       +8     
  Branches     3503     3506       +3     
==========================================
+ Hits        10990    10997       +7     
- Misses        747      748       +1     
  Partials      296      296              

Flag	Coverage Δ
unittest	91.32% <90.90%> (-0.01%)	⬇️

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

Impacted Files	Coverage Δ
...-estree/src/create-program/createProjectProgram.ts	93.47% <90.90%> (-0.81%)	⬇️
...ackages/eslint-plugin/src/rules/member-ordering.ts	95.62% <0.00%> (-0.10%)	⬇️

[a-churchill]

As an end user I think the updated error message + associated docs are very helpful!

[bradzacher]

not a full review, just a few comments

[bradzacher]

summore comments! Looking good!

[JoshuaKGoldberg]

I split this section into these two h3s. Re-reading the un-split explanation felt like a tl;dr. My instinct is users just want to know how to fix this ASAP.

[bradzacher]