docs: blog post on parserOptions.projectService #8031

JoshuaKGoldberg · 2023-12-06T18:46:09Z

PR Checklist

Addresses an existing open issue: fixes Docs: Add blog post & revamped docs for parserOptions.projectService #7350
That issue was marked as accepting prs
Steps in Contributing were taken

Overview

Adds a blog post that describes using parserOptions.projectService (what we currently call parserOptions.EXPERIMENTAL_useProjectService). ~~It sets up a plan to call it projectService in v7, then replace project in v8.~~ Any renaming plans are removed.

Note that this is blocked on:

feat(typescript-estree): add allowDefaultProjectForFiles project service allowlist option #7752: for locking down how an "additional files / to be given default program type info" should look
feat: add support for flat configs #7935: for example flat configs in the post
Creating a set of example configs on a new, not-yet-created https://github.com/typescript-eslint/examples
Enhancement: Finalize naming for EXPERIMENTAL_useProjectService #9004
Creating and running performance comparisons on ~~a new, not-yet-created https://github.com/typescript-eslint/project-apis-performance-comparison~~ https://github.com/typescript-eslint/performance

This is where my mindset is for the option.

💖

typescript-eslint · 2023-12-06T18:46:12Z

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 · 2023-12-06T18:46:14Z

❌ Deploy Preview for typescript-eslint failed.

Name	Link
🔨 Latest commit	`2cead57`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/66c3297ab71b050008606ffd

packages/website/blog/2023-09-18-parser-options-project-true.md

packages/website/blog/2024-03-01-parser-options-project-service.md

Josh-Cena

Great to see exciting features

packages/website/blog/2024-03-01-parser-options-project-service.md

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

packages/website/blog/2024-03-01-parser-options-project-service.md

nx-cloud · 2024-05-11T14:53:10Z

☁️ Nx Cloud Report

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

📂 See all runs for this CI Pipeline Execution

🟥 Failed Commands
`nx test typescript-estree --coverage=false`
`nx run-many --target=typecheck`

✅ Successfully ran 12 targets

Sent with 💌 from NxCloud.

JoshuaKGoldberg · 2024-07-18T21:48:39Z

Status update: this is roughly ready for review except parserOptions.projectService no longer outperforms parserOptions.project. That's being investigated in #9571. If we don't get enough fixes on our end & TypeScript's by the time v8 is meant to go stable, we'll have to rephrase the ⚡ Performance section.

codecov · 2024-07-18T21:49:33Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.93%. Comparing base (3d78392) to head (acc7d9f).
Report is 394 commits behind head on main.

❗ Current head acc7d9f differs from pull request most recent head 2cead57

Please upload reports for the commit 2cead57 to get more accurate results.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #8031   +/-   ##
=======================================
  Coverage   87.93%   87.93%           
=======================================
  Files         403      403           
  Lines       13796    13796           
  Branches     4022     4022           
=======================================
  Hits        12131    12131           
  Misses       1358     1358           
  Partials      307      307

Flag	Coverage Δ
unittest	`87.93% <ø> (ø)`

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

JoshuaKGoldberg · 2024-07-24T00:32:31Z

packages/website/blog/2024-08-15-parser-options-project-service.mdx

+
+We recommend switching to `parserOptions.projectService` if possible.
+
+## ⚡️ Performance Comparisons


So I don't forget: t3-oss/create-t3-app#1936 (comment) is an example of a perf improvement in the wild.

packages/website/blog/2024-08-15-parser-options-project-service.mdx

Zamiell · 2024-08-12T20:08:38Z

Can you rebase this on main? It looks like the PR has 475 changed files, which doesn't seem to be right.

(Context: I'm trying to read the upcoming blog post to learn more about how exactly to configure my projectService setting.)

JoshuaKGoldberg · 2024-08-13T05:12:27Z

packages/website/docusaurus.config.mts

Changes here are unintentional merge artifacts. Will revert.

AdamVig · 2024-11-08T17:18:46Z

packages/website/blog/2024-08-25-parser-options-project-service.mdx

+- ESLint's `--fix` mode breaks type information after the first run ([#9577](https://github.com/typescript-eslint/typescript-eslint/pull/9577))
+- Extra file extensions, such as those used by `.svelte` and `.vue`, are not supported ([#9504](https://github.com/typescript-eslint/typescript-eslint/issues/9504))
+
+typescript-eslint's single-run inference enables uses common heuristics such as checking for `'--fix'` in `process.argv`, the presence of `process.env.CI`, and the presence of `parserOptions.extraFileExtensions`.


nit: typo, I made a guess at the intended wording:

Suggested change

typescript-eslint's single-run inference enables uses common heuristics such as checking for `'--fix'` in `process.argv`, the presence of `process.env.CI`, and the presence of `parserOptions.extraFileExtensions`.

typescript-eslint's single-run inference uses common heuristics such as checking for `'--fix'` in `process.argv`, the presence of `process.env.CI`, and the presence of `parserOptions.extraFileExtensions`.

docs: blog post on parserOptions.projectService

be19629

JoshuaKGoldberg commented Dec 6, 2023

View reviewed changes

packages/website/blog/2023-09-18-parser-options-project-true.md Outdated Show resolved Hide resolved

JoshuaKGoldberg commented Dec 6, 2023

View reviewed changes

packages/website/blog/2024-03-01-parser-options-project-service.md Outdated Show resolved Hide resolved

JoshuaKGoldberg commented Dec 6, 2023

View reviewed changes

packages/website/blog/2024-03-01-parser-options-project-service.md Outdated Show resolved Hide resolved

JoshuaKGoldberg requested a review from bradzacher December 22, 2023 23:00

liuxingbaoyu mentioned this pull request Dec 23, 2023

chore: Enable useProjectService babel/babel#16192

Merged

bradzacher reviewed Dec 23, 2023

View reviewed changes

JoshuaKGoldberg and others added 2 commits December 24, 2023 00:23

Update packages/website/blog/2023-09-18-parser-options-project-true.md

105a406

Better diffs and a bit of streamlining

a107204

JoshuaKGoldberg commented Dec 24, 2023

View reviewed changes

packages/website/blog/2024-03-01-parser-options-project-service.md Outdated Show resolved Hide resolved

Account for solo and project references at each scale

31cbb5d

Josh-Cena reviewed Dec 24, 2023

View reviewed changes

JoshuaKGoldberg commented Dec 27, 2023

View reviewed changes

packages/website/blog/2024-03-01-parser-options-project-service.md Outdated Show resolved Hide resolved

Apply suggestions from code review

c0b6d90

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>

JoshuaKGoldberg mentioned this pull request Jan 25, 2024

ESLint does not re-compute cross-file information on file changes microsoft/vscode-eslint#1774

Open

Jack-Works reviewed Feb 26, 2024

View reviewed changes

packages/website/blog/2024-03-01-parser-options-project-service.md Outdated Show resolved Hide resolved

This was referenced Apr 26, 2024

Enhancement: Finalize naming for EXPERIMENTAL_useProjectService #9003

Closed

Enhancement: Finalize naming for EXPERIMENTAL_useProjectService #9004

Closed

JoshuaKGoldberg added this to the 8.0.0 milestone Apr 26, 2024

JoshuaKGoldberg mentioned this pull request May 2, 2024

feat: enable @typescript-eslint/recommended in create-next-app --typescript vercel/next.js#52845

Merged

JoshuaKGoldberg added 2 commits May 11, 2024 07:50

Merge branch 'main'

17fd25f

Adjusted vision section

a7097ac

JoshuaKGoldberg mentioned this pull request May 13, 2024

feat(typescript-estree): stabilize EXPERIMENTAL_useProjectService as projectService #9084

Merged

3 tasks

JoshuaKGoldberg mentioned this pull request Jun 22, 2024

Bug: Vue + TypeScript project slowdown with v8 alpha #9312

Closed

4 tasks

Merge branch 'main' into blog-parser-options-project-service

123052c

JoshuaKGoldberg added the blocked by another PR PRs which are ready to go but waiting on another PR label Jul 18, 2024

JoshuaKGoldberg added blocked by external API Blocked by a tool we depend on exposing an API, such as TypeScript's Type Relationship API blocked by another issue Issues which are not ready because another issue needs to be resolved first labels Jul 18, 2024

JoshuaKGoldberg added 2 commits July 18, 2024 17:49

Refreshed blog post for latest versions and names

3ca6cbc

Merge branch 'v8' into blog-parser-options-project-service

f40e7a1

JoshuaKGoldberg changed the base branch from main to v8 July 18, 2024 21:49

JoshuaKGoldberg commented Jul 24, 2024

View reviewed changes

AhmedBaset reviewed Jul 27, 2024

View reviewed changes

packages/website/blog/2024-08-15-parser-options-project-service.mdx Outdated Show resolved Hide resolved

JoshuaKGoldberg removed this from the 8.0.0 milestone Jul 28, 2024

JoshuaKGoldberg changed the base branch from v8 to main July 31, 2024 17:06

teppeis mentioned this pull request Aug 7, 2024

fix(deps): update typescript-eslint to v8 teppeis/eslint-config-teppeis#1327

Merged

AndreaPontrandolfo mentioned this pull request Aug 12, 2024

Switch to typescript-eslint projectService AndreaPontrandolfo/sheriff#203

Open

4 tasks

Merge branch 'main' into blog-parser-options-project-service

acc7d9f

JoshuaKGoldberg commented Aug 13, 2024

View reviewed changes

packages/website/docusaurus.config.mts Outdated

Copy link

Member Author

JoshuaKGoldberg Aug 13, 2024

Choose a reason for hiding this comment

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

Changes here are unintentional merge artifacts. Will revert.

This was referenced Aug 16, 2024

Docs: Render backtick-ed text as code in blog titles #9806

Closed

Enhancement: Default projectService.defaultProject to "tsconfig.json" #9807

Closed

Real world examples

2cead57

JoshuaKGoldberg mentioned this pull request Aug 23, 2024

docs: add more project service docs and FAQs #9871

Merged

3 tasks

AdamVig reviewed Nov 8, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: blog post on parserOptions.projectService #8031

docs: blog post on parserOptions.projectService #8031

JoshuaKGoldberg commented Dec 6, 2023 •

edited

Loading

typescript-eslint bot commented Dec 6, 2023

netlify bot commented Dec 6, 2023 •

edited

Loading

Josh-Cena left a comment

nx-cloud bot commented May 11, 2024 •

edited

Loading

JoshuaKGoldberg commented Jul 18, 2024

codecov bot commented Jul 18, 2024 •

edited

Loading

JoshuaKGoldberg Jul 24, 2024

Zamiell commented Aug 12, 2024

JoshuaKGoldberg Aug 13, 2024

AdamVig Nov 8, 2024


		We recommend switching to `parserOptions.projectService` if possible.

		## ⚡️ Performance Comparisons

	typescript-eslint's single-run inference enables uses common heuristics such as checking for `'--fix'` in `process.argv`, the presence of `process.env.CI`, and the presence of `parserOptions.extraFileExtensions`.
	typescript-eslint's single-run inference uses common heuristics such as checking for `'--fix'` in `process.argv`, the presence of `process.env.CI`, and the presence of `parserOptions.extraFileExtensions`.

docs: blog post on parserOptions.projectService #8031

Are you sure you want to change the base?

docs: blog post on parserOptions.projectService #8031

Conversation

JoshuaKGoldberg commented Dec 6, 2023 • edited Loading

PR Checklist

Overview

typescript-eslint bot commented Dec 6, 2023

netlify bot commented Dec 6, 2023 • edited Loading

❌ Deploy Preview for typescript-eslint failed.

Josh-Cena left a comment

Choose a reason for hiding this comment

nx-cloud bot commented May 11, 2024 • edited Loading

☁️ Nx Cloud Report

JoshuaKGoldberg commented Jul 18, 2024

codecov bot commented Jul 18, 2024 • edited Loading

Codecov Report

JoshuaKGoldberg Jul 24, 2024

Choose a reason for hiding this comment

Zamiell commented Aug 12, 2024

JoshuaKGoldberg Aug 13, 2024

Choose a reason for hiding this comment

AdamVig Nov 8, 2024

Choose a reason for hiding this comment

JoshuaKGoldberg commented Dec 6, 2023 •

edited

Loading

netlify bot commented Dec 6, 2023 •

edited

Loading

nx-cloud bot commented May 11, 2024 •

edited

Loading

codecov bot commented Jul 18, 2024 •

edited

Loading