feat(parser, typescript-estree): export withoutProjectParserOptions utility #9233
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks for the PR, @fpapado! 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. |
fpapado
commented
Jun 3, 2024
packages/typescript-estree/src/removeParserOptionsThatPromptTypechecking.ts
Outdated
Show resolved
Hide resolved
JoshuaKGoldberg
requested changes
Jun 3, 2024
packages/typescript-estree/src/removeParserOptionsThatPromptTypechecking.ts
Outdated
Show resolved
Hide resolved
packages/typescript-estree/src/removeParserOptionsThatPromptTypechecking.ts
Outdated
Show resolved
Hide resolved
packages/typescript-estree/src/removeParserOptionsThatPromptTypechecking.ts
Outdated
Show resolved
Hide resolved
|
Thanks for the suggestions, they all make sense! Let me know if anything else comes up ✍️ |
packages/typescript-estree/tests/lib/withoutProjectParserOptions.test.ts
Show resolved
Hide resolved
Josh-Cena
reviewed
Jun 4, 2024
docs/packages/Parser.mdx
Outdated
Comment on lines
361
to
368
| Removes options that prompt the parser to parse the project with type | ||
| information. In other words, you can use this if you are invoking the parser | ||
| directly, to ensure that one file will be parsed in isolation, which is much, | ||
| much faster. | ||
|
|
||
| This is useful in cases where you invoke the parser directly, such as in an | ||
| ESLint plugin context. | ||
|
|
There was a problem hiding this comment.
Don't wrap lines by width. Either no breaks or wrap at sentence stops.
There was a problem hiding this comment.
Thanks for catching this! Changed to sentence stops in 15d47de
packages/typescript-estree/tests/lib/withoutProjectParserOptions.test.ts
Outdated
Show resolved
Hide resolved
c9a6dd9
into
typescript-eslint:main
66 of 68 checks passed
4 tasks
This comment was marked as off-topic.
This comment was marked as off-topic.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Checklist
Overview
Adds the utility described in #8428, allowing direct callers of the parser to omit options that would cause typechecking / type information to be collected. This essentially inverts the control back into
typescript-eslint's codebase, and avoids having to sync changes across multiple third-party packages.The primary motivation is
eslint-plugin-import, which uses the parser in isolation (hrough some eslint indirection), and sees a large speedup by not collecting type information.Rationale and Open Questions
I placed the utility in
typescript-estree, so that it is co-located with the parser options themselves. The utility is re-exported by@typescript-eslint/parser, since I imagine that a a conditionalrequire(as described in #8428) would import the parser. It's a bit hard to design this without trying the call-site 😅The current implementation uses
TSESTreeOptions. This means that we would need a separate PR for thev8branch, which deletes only the things relevant to it. I think that's kinda nice, since we only ever touch keys that are relevant for the resolved parser. But, I might be missing something!(I added one other question in a PR comment)