chore: document and refactor 'extra' to 'parserSettings' by JoshuaKGoldberg · Pull Request #5834 · typescript-eslint/typescript-eslint

JoshuaKGoldberg · 2022-10-16T02:58:08Z

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 · 2022-10-16T02:58:10Z

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 · 2022-10-16T02:58:10Z

☁️ 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

Sent with 💌 from NxCloud.

netlify · 2022-10-16T02:58:25Z

✅ 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 · 2022-10-16T03:12:16Z

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!

packages/typescript-estree/src/create-program/createSourceFile.ts

packages/typescript-estree/src/log.ts

packages/typescript-estree/src/parseSettings.ts

packages/typescript-estree/src/warnAboutTSVersion.ts

JoshuaKGoldberg · 2022-10-24T19:27:00Z

$ /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

packages/typescript-estree/src/parseSettings/createParseSettings.ts

…gs.ts Co-authored-by: Brad Zacher <brad.zacher@gmail.com>

…xtra-to-parser-settings

packages/typescript-estree/src/parseSettings/index.ts

JoshuaKGoldberg · 2022-10-25T14:06:16Z

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

) * refactor(utils)!: removed `TRuleListener` generic from the `createRule` * refactor!: removed `TRuleListener` generic from the `CLIEngine` and `RuleCreateFunction` * chore: document and refactor 'extra' to 'parserSettings' (#5834) * chore(website): fix renamed Sponsorship docs link (#5882) * docs: Mention wide globs performance implications in monorepos docs and parser README (#5864) * docs: Mention wide globs performance implications in monorepos docs and parser readme * Update docs/linting/typed-linting/MONOREPOS.md Co-authored-by: Josh Goldberg <git@joshuakgoldberg.com> Co-authored-by: Josh Goldberg <git@joshuakgoldberg.com> Co-authored-by: Adnan Hashmi <56730784+adnanhashmi09@users.noreply.github.com>

* feat: update TSImportType node * fix: update visitor keys * chore: document and refactor 'extra' to 'parserSettings' (#5834) * chore(website): fix renamed Sponsorship docs link (#5882) * docs: Mention wide globs performance implications in monorepos docs and parser README (#5864) * docs: Mention wide globs performance implications in monorepos docs and parser readme * Update docs/linting/typed-linting/MONOREPOS.md Co-authored-by: Josh Goldberg <git@joshuakgoldberg.com> Co-authored-by: Josh Goldberg <git@joshuakgoldberg.com> Co-authored-by: Adnan Hashmi <56730784+adnanhashmi09@users.noreply.github.com>

* feat(scope-manager): ignore ECMA version * chore: document and refactor 'extra' to 'parserSettings' (#5834) * chore(website): fix renamed Sponsorship docs link (#5882) * Remove much more * Fix WebLinter lint * docs: Mention wide globs performance implications in monorepos docs and parser README (#5864) * docs: Mention wide globs performance implications in monorepos docs and parser readme * Update docs/linting/typed-linting/MONOREPOS.md Co-authored-by: Josh Goldberg <git@joshuakgoldberg.com> * chore: add auto-canary release for v6 (#5883) Co-authored-by: Adnan Hashmi <56730784+adnanhashmi09@users.noreply.github.com>

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

3ead14e

JoshuaKGoldberg force-pushed the extra-to-parser-settings branch from 8e502de to 3ead14e Compare October 16, 2022 03:11

JoshuaKGoldberg marked this pull request as ready for review October 17, 2022 02:21

JoshuaKGoldberg requested a review from bradzacher October 17, 2022 02:21

bradzacher added the refactor PRs that refactor code only label Oct 24, 2022

bradzacher reviewed Oct 24, 2022

View reviewed changes

bradzacher added the awaiting response Issues waiting for a reply from the OP or another party label Oct 24, 2022

JoshuaKGoldberg mentioned this pull request Oct 24, 2022

Repo: Standardize debug namespaces per-file #5872

Closed

Broke up type cycle and made it readonly

25f1509

JoshuaKGoldberg removed the awaiting response Issues waiting for a reply from the OP or another party label Oct 24, 2022

Merge branch 'main' into extra-to-parser-settings

dccb222

bradzacher previously approved these changes Oct 24, 2022

View reviewed changes

packages/typescript-estree/src/parseSettings/createParseSettings.ts Outdated Show resolved Hide resolved

bradzacher added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Oct 24, 2022

JoshuaKGoldberg dismissed bradzacher’s stale review via 7b4f8d8 October 25, 2022 13:49

JoshuaKGoldberg and others added 3 commits October 25, 2022 09:49

Update packages/typescript-estree/src/parseSettings/createParseSettin…

7b4f8d8

…gs.ts Co-authored-by: Brad Zacher <brad.zacher@gmail.com>

Merge branch 'main'

1f11cac

Merge remote-tracking branch 'origin/extra-to-parser-settings' into e…

01adaac

…xtra-to-parser-settings

JoshuaKGoldberg commented Oct 25, 2022

View reviewed changes

packages/typescript-estree/src/parseSettings/index.ts Outdated Show resolved Hide resolved

Update packages/typescript-estree/src/parseSettings/index.ts

7b7d2e8

JoshuaKGoldberg mentioned this pull request Oct 25, 2022

Refactor: Deprecate createDefaultProgram/shouldCreateDefaultProgram #5857

Closed

Merge branch 'main' into extra-to-parser-settings

044f177

JoshuaKGoldberg mentioned this pull request Oct 25, 2022

[Public API request] make parseForESLint accept ts.sourceFile #774

Closed

bradzacher approved these changes Oct 25, 2022

View reviewed changes

bradzacher merged commit 8ddcc9a into typescript-eslint:main Oct 25, 2022

JoshuaKGoldberg deleted the extra-to-parser-settings branch October 25, 2022 22:24

github-actions bot locked as resolved and limited conversation to collaborators Nov 17, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

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

chore: document and refactor 'extra' to 'parserSettings'#5834
bradzacher merged 8 commits intotypescript-eslint:mainfrom
JoshuaKGoldberg:extra-to-parser-settings

JoshuaKGoldberg commented Oct 16, 2022 •

edited

Loading

Uh oh!

typescript-eslint bot commented Oct 16, 2022

Uh oh!

nx-cloud bot commented Oct 16, 2022 •

edited

Loading

Uh oh!

netlify bot commented Oct 16, 2022 •

edited

Loading

Uh oh!

codecov bot commented Oct 16, 2022 •

edited

Loading

Uh oh!

bradzacher left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JoshuaKGoldberg commented Oct 24, 2022 •

edited

Loading

Uh oh!

bradzacher left a comment

Uh oh!

Uh oh!

Uh oh!

JoshuaKGoldberg commented Oct 25, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

JoshuaKGoldberg commented Oct 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Checklist

Overview

Uh oh!

typescript-eslint bot commented Oct 16, 2022

Uh oh!

nx-cloud bot commented Oct 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

☁️ Nx Cloud Report

Uh oh!

netlify bot commented Oct 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for typescript-eslint ready!

Uh oh!

codecov bot commented Oct 16, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

bradzacher left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JoshuaKGoldberg commented Oct 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bradzacher left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

JoshuaKGoldberg commented Oct 25, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

JoshuaKGoldberg commented Oct 16, 2022 •

edited

Loading

nx-cloud bot commented Oct 16, 2022 •

edited

Loading

netlify bot commented Oct 16, 2022 •

edited

Loading

codecov bot commented Oct 16, 2022 •

edited

Loading

JoshuaKGoldberg commented Oct 24, 2022 •

edited

Loading