Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork2.8k
docs: add more project service docs and FAQs#9871
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
docs: add more project service docs and FAQs#9871
Uh oh!
There was an error while loading.Please reload this page.
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 onhttps://opencollective.com/typescript-eslint. |
netlifybot commentedAug 23, 2024 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
✅ Deploy Preview fortypescript-eslint ready!
To edit notification comments on pull requests, go to yourNetlify site configuration. |
nx-cloudbot commentedAug 23, 2024 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
☁️ Nx Cloud ReportCI is running/has finished running commands for commitef44301. 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 💌 fromNxCloud. |
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" /> |
JoshuaKGoldbergAug 23, 2024 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
It was bugging me that the h5s underProjectServiceOptions
were roughly the same font size & weight as the text around them...
d9f66da
intotypescript-eslint:mainUh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
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..js
files withoutallowJs
/checkJs
)tsconfig.json
files as the main file path; if you're using TSConfigs to build with a separate system, building should be the custom non-tsconfig.json
paths (e.g.tsconfig.build.json
)💖