docs: add more project service docs and FAQs #9871
Conversation
|
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. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
☁️ Nx Cloud ReportCI is running/has finished running commands for commit ef44301. 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 ✅ Successfully ran 2 targetsSent with 💌 from NxCloud. |
|
|
||
| See [issue #2094 discussing project references](https://github.com/typescript-eslint/typescript-eslint/issues/2094) for more details. | ||
|
|
||
| ## Project Service Issues | ||
|
|
||
| <HiddenHeading id="allowdefaultproject-glob-too-wide" /> | ||
| <HiddenHeading id="allowdefaultprojectforfiles-glob-too-wide" /> |
There was a problem hiding this comment.
This second heading is a holdover from the experimental/v7 name. I think anybody newly configuring the service should reasonably be on v8 now. Our docs don't still hold true for the old experimental way of holding the project service.
| @@ -320,38 +321,49 @@ module.exports = { | |||
| This option brings two main benefits over the older `project`: | |||
|
|
|||
| - Simpler configurations: most projects shouldn't need to explicitly configure `project` paths or create `tsconfig.eslint.json`s | |||
| - Improved performance: this API is optimized on the TypeScript side for speed | |||
| - Initial versions of this option demonstrated performance changes in subsets of the typescript-eslint monorepo ranging from 11% slower to 70% faster | |||
There was a problem hiding this comment.
We're still working on performance & filling in the gaps on edge cases. IMO we should stop bragging about it until we can be very, very certain it's better the vast majority of the time.
|
|
||
| h5 { | ||
| font-weight: bold; | ||
| } |
There was a problem hiding this comment.
It was bugging me that the h5s under ProjectServiceOptions were roughly the same font size & weight as the text around them...
d9f66da
into
typescript-eslint:main
PR Checklist
Overview
Steals some of the docs from #8031 so we can get them in sooner.
Also adds in FAQs around the most common mishaps we've seen from users. Largely:
tsconfig.json(e.g..jsfiles withoutallowJs/checkJs)tsconfig.jsonfiles as the main file path; if you're using TSConfigs to build with a separate system, building should be the custom non-tsconfig.jsonpaths (e.g.tsconfig.build.json)💖