feat(typescript-estree): allow providing code as a ts.SourceFile

[JoshuaKGoldberg]

PR Checklist

• Addresses an existing open issue: fixes [Public API request] make parseForESLint accept ts.sourceFile  #774
• That issue was marked as accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

Changes several function parameters from code: string to code: string | ts.SourceFile. Folks should now be able to pass in a source file directly, instead of the text of a file that we then have to redundantly reparse.

Targeting the v6 branch even though this arguably isn't really a breaking change. Since this is such a core API, I'd want it to be able to benefit from the v6 testing process too.

[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.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 10cf653. 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 18 - nx test @typescript-eslint/eslint-plugin
• Node 14 - nx test @typescript-eslint/eslint-plugin --coverage=false
• Node 18 - nx test @typescript-eslint/typescript-estree
• Node 18 - nx test @typescript-eslint/scope-manager
• Node 14 - nx test @typescript-eslint/typescript-estree --coverage=false
• Node 18 - nx test @typescript-eslint/type-utils
• Node 18 - nx test @typescript-eslint/utils
• Node 18 - nx test @typescript-eslint/visitor-keys
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• 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 18 - nx test @typescript-eslint/eslint-plugin-internal
• 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 18 - nx test @typescript-eslint/eslint-plugin-tslint
• 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 18 - nx test @typescript-eslint/parser
• 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 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• 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 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/utils --coverage=false
• nx run-many --target=typecheck --all --parallel
• Node 14 - nx test @typescript-eslint/scope-manager --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/eslint-plugin-internal --coverage=false
• 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 test @typescript-eslint/type-utils --coverage=false
• Node 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• 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 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/ast-spec --coverage=false
• Node 14 - 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
• Node 14 - 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.

[codecov]

Codecov Report

Merging #5892 (10cf653) into v6 (c446386) will increase coverage by 0.33%.
The diff coverage is 90.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##               v6    #5892      +/-   ##
==========================================
+ Coverage   91.35%   91.68%   +0.33%     
==========================================
  Files         364      356       -8     
  Lines       12132    12021     -111     
  Branches     3533     3523      -10     
==========================================
- Hits        11083    11022      -61     
+ Misses        750      701      -49     
+ Partials      299      298       -1     

Flag	Coverage Δ
unittest	91.68% <90.00%> (+0.33%)	⬆️

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

Impacted Files	Coverage Δ
...estree/src/create-program/createIsolatedProgram.ts	76.00% <ø> (ø)
...ript-estree/src/create-program/createSourceFile.ts	77.77% <50.00%> (-9.73%)	⬇️
...pt-estree/src/parseSettings/createParseSettings.ts	95.31% <75.00%> (-1.52%)	⬇️
packages/typescript-estree/src/ast-converter.ts	100.00% <100.00%> (ø)
...-estree/src/create-program/createDefaultProgram.ts	78.26% <100.00%> (ø)
...pt-estree/src/create-program/createWatchProgram.ts	83.88% <100.00%> (+5.82%)	⬆️
packages/typescript-estree/src/source-files.ts	100.00% <100.00%> (ø)
packages/typescript-estree/src/convert.ts	97.85% <0.00%> (-0.06%)	⬇️
packages/typescript-estree/src/version-check.ts	100.00% <0.00%> (ø)
... and 16 more

[JoshuaKGoldberg]

FYI @Quramy - is there anything else you'd need/want done to help with the use case described in #774?

cc @mhartington - you were showing me using Quramy's language service plugin. I'm betting this will speed it up ever so slightly (though I'd be surprised if file parsing was a major bottleneck). ✨