chore: document and refactor 'extra' to 'parserSettings'

[JoshuaKGoldberg]

PR Checklist

• Addresses an existing open issue: fixes Refactor: replace module-scoped code and extra variables #5833
• That issue was marked as accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

Despite the nontrivial diff, this shouldn't change any significant logic.

• Replaces the ast, code, extra, and program module scoped variables into parameters that get passed around
  • Wherever possible, combines multiple parameters that reference members of extra
• Renames Extra to ParseSettings and adds doc comments for its properties
• Extracts & deduplicates the logic to create parserSettings (formerly extra) into a createParseSettings function, and makes it almost all happen in-place

I'm choosing to ignore the Codecov complaint because the diff is reducing lines of code ✨. But if you think we should test these edge cases more, I could use some help figuring out where that should go.

[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 044f177. 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/type-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
• 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/typescript-estree
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• 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=typecheck --all --parallel
• Node 18 - nx test @typescript-eslint/parser
• Node 18 - 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 18 - nx test @typescript-eslint/ast-spec
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/type-utils --coverage=false
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/utils --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 test @typescript-eslint/eslint-plugin-internal --coverage=false
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/typescript-estree --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 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 14 - nx test @typescript-eslint/ast-spec --coverage=false
• Node 14 - nx test @typescript-eslint/parser --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 14 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/eslint-plugin-tslint
• Node 14 - nx test @typescript-eslint/visitor-keys --coverage=false
• Node 14 - nx test @typescript-eslint/scope-manager --coverage=false
• 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
• 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.

[netlify]

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	044f177
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6357ed4ec3d3df000f4a7624
😎 Deploy Preview	https://deploy-preview-5834--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 #5834 (044f177) into main (c4e0d86) will increase coverage by 0.03%.
The diff coverage is 89.92%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #5834      +/-   ##
==========================================
+ Coverage   91.33%   91.36%   +0.03%     
==========================================
  Files         361      364       +3     
  Lines       12044    12134      +90     
  Branches     3506     3540      +34     
==========================================
+ Hits        11000    11086      +86     
  Misses        748      748              
- Partials      296      300       +4     

Flag	Coverage Δ
unittest	91.36% <89.92%> (+0.03%)	⬆️

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

Impacted Files	Coverage Δ
...ript-estree/src/create-program/createSourceFile.ts	87.50% <0.00%> (ø)
...t-estree/src/create-program/useProvidedPrograms.ts	84.84% <50.00%> (ø)
...-estree/src/create-program/createDefaultProgram.ts	78.26% <71.42%> (+0.98%)	⬆️
...ges/typescript-estree/src/create-program/shared.ts	83.33% <75.00%> (ø)
...pt-estree/src/create-program/createWatchProgram.ts	78.06% <78.57%> (ø)
...-estree/src/create-program/createProjectProgram.ts	93.47% <81.81%> (ø)
...escript-estree/src/parseSettings/inferSingleRun.ts	90.90% <90.90%> (ø)
...ipt-estree/src/parseSettings/warnAboutTSVersion.ts	93.33% <93.33%> (ø)
...pt-estree/src/parseSettings/createParseSettings.ts	96.82% <96.82%> (ø)
packages/typescript-estree/src/ast-converter.ts	100.00% <100.00%> (ø)
... and 1 more

[bradzacher]

this is looking fantastic!

[JoshuaKGoldberg]

$ /home/runner/work/typescript-eslint/typescript-eslint/node_modules/.bin/playwright test --reporter=list

Running 1 test using 1 worker

  ✘  1 [chromium] › index.spec.ts:4:1 › Index (30s)


  1) [chromium] › index.spec.ts:4:1 › Index ========================================================

    Test timeout of 30000ms exceeded.

    Error: page.evaluate: Target closed
     Please check out https://github.com/dequelabs/axe-core-npm/blob/develop/packages/playwright/error-handling.md

        at AxeBuilder.<anonymous> (/home/runner/work/typescript-eslint/typescript-eslint/node_modules/@axe-core/playwright/src/index.ts:172:[13](https://github.com/typescript-eslint/typescript-eslint/actions/runs/3315439920/jobs/5476094015#step:6:14))
        at step (/home/runner/work/typescript-eslint/typescript-eslint/node_modules/@axe-core/playwright/dist/index.js:33:23)
        at Object.throw (/home/runner/work/typescript-eslint/typescript-eslint/node_modules/@axe-core/playwright/dist/index.js:[14](https://github.com/typescript-eslint/typescript-eslint/actions/runs/3315439920/jobs/5476094015#step:6:15):53)
        at rejected (/home/runner/work/typescript-eslint/typescript-eslint/node_modules/@axe-core/playwright/dist/index.js:6:65)

    Pending operations:
      - page.evaluate at ../../node_modules/@axe-core/playwright/src/index.ts:[28](https://github.com/typescript-eslint/typescript-eslint/actions/runs/3315439920/jobs/5476094015#step:6:29)5:8

😭

Edit: went away on re-run. I'm going to pretend this little blip never happened.

[bradzacher]

[JoshuaKGoldberg]

Getting real tired of having to re-request review after merges 🥲