Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Mention wide globs performance implications in monorepos docs and parser README #5864

Conversation

adnanhashmi09
Copy link
Contributor

PR Checklist

Overview

Adds a mention of the performance issues with ** in monorepo docs and parser's README a link to the issue.

@nx-cloud
Copy link

nx-cloud bot commented Oct 24, 2022

☁️ Nx Cloud Report

CI is running/has finished running commands for commit b02bbb5. 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.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @adnanhashmi09!

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.

@netlify
Copy link

netlify bot commented Oct 24, 2022

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit b02bbb5
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/635862591c20500009464037
😎 Deploy Preview https://deploy-preview-5864--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@adnanhashmi09
Copy link
Contributor Author

@JoshuaKGoldberg Please review this PR and suggest any necessary changes.

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

Super, thanks!

Long term if we keep adding to this page we might want to shorten the size of those .eslintrc.js code blocks. But for now I think it's fine - and helps emphasize our recommended config starter.

docs/linting/typed-linting/MONOREPOS.md Outdated Show resolved Hide resolved
@JoshuaKGoldberg JoshuaKGoldberg enabled auto-merge (squash) October 24, 2022 19:15
@bradzacher bradzacher added the documentation Documentation ("docs") that needs adding/updating label Oct 25, 2022
@JoshuaKGoldberg JoshuaKGoldberg merged commit fcf3f9d into typescript-eslint:main Oct 25, 2022
JoshuaKGoldberg added a commit that referenced this pull request Oct 25, 2022
)

* 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>
JoshuaKGoldberg added a commit that referenced this pull request Oct 26, 2022
* 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>
JoshuaKGoldberg added a commit that referenced this pull request Oct 26, 2022
* 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>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 17, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Documentation ("docs") that needs adding/updating
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: parserOptions.project may have performance implications when using ** glob patterns
3 participants