docs(typescript-estree): warn users about performance of glob in project option#2602

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

Jump to bottom

Closed

tosmolka wants to merge1 commit intotypescript-eslint:masterfromtosmolka:docs-glob

Closed

docs(typescript-estree): warn users about performance of glob in project option#2602

tosmolka wants to merge1 commit intotypescript-eslint:masterfromtosmolka:docs-glob

Conversation

Copy link

Contributor

tosmolka commentedSep 25, 2020

When parser resolves project files referenced via glob pattern - it does so for every single scanned file individually. This causes huge performance downgrade when scanning large projects and using wide glob pattern (e.g. **/tsconfig.json).

We could consider improving performance in such cases (maybe caching?) but in the meantime, I am proposing addition to docs that warns users about this corner case.

Any feedback appreciated!

docs(typescript-estree): warn users about performance of glob in proj…

5eeed42

…ect option

Copy link

Contributor

typescript-eslintbot commentedSep 25, 2020

Thanks for the PR,@tosmolka!

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 visitorsper day.