Assume an eval context for Prism::Translation::Parser
#2741
Conversation
This file contains 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
This is similar to davidwessman/syntax_tree-erb#81 but for RuboCop The parser gem doesn't support these types of checks, see https://github.com/whitequark/parser?tab=readme-ov-file#syntax-check-of-block-exits While this is technically a bug in the parser gem, it does increase compatibility and allows prism to be used when linting erb or haml with a RuboCop extension.
rafaelfranca
added a commit
to Shopify/packwerk
that referenced
this pull request
May 2, 2024
Top level yields are invalid Ruby on files, but are valid on `eval`. They exist on ERB files, and since those files are evaluated no written to disk they are fine. We can tell Prism to parse the code using the eval context by passing `scopes: [[]]` to `parse`, but since are are using the `Prism::Translation::Parser` class we have no way to do that. A [PR][1] was proposed to Prism to always consider the code as being evaluated in the `Parser` translation. For now, we can safely ignore that class of error by overriding the `valid_error?` method on our own parser. Fixes #400. [1]: ruby/prism#2741
rafaelfranca
added a commit
to Shopify/packwerk
that referenced
this pull request
May 2, 2024
Top level yields are invalid Ruby on files, but are valid on `eval`. They exist on ERB files, and since those files are evaluated no written to disk they are fine. We can tell Prism to parse the code using the eval context by passing `scopes: [[]]` to `parse`, but since are are using the `Prism::Translation::Parser` class we have no way to do that. A [PR][1] was proposed to Prism to always consider the code as being evaluated in the `Parser` translation. For now, we can safely ignore that class of error by overriding the `valid_error?` method on our own parser. Fixes #400. [1]: ruby/prism#2741
kddnewton
approved these changes
May 3, 2024
Earlopain
added a commit
to Earlopain/rubocop
that referenced
this pull request
Jun 10, 2024
Most of these got disabled in rubocop#12822 It is however rather important that these cases parse sinc some extensions rely on parsing code line by line. This is the case when extracting code from a templating language like erb or haml Prism was changed to allow these cases in ruby/prism#2741 `packwerk`ran into issue: Shopify/packwerk#400 I myself observed the same in `rubocop-erb`
8 tasks
Earlopain
added a commit
to Earlopain/rubocop
that referenced
this pull request
Jun 10, 2024
Most of these got disabled in rubocop#12822 It is however rather important that these cases parse sinc some extensions rely on parsing code line by line. This is the case when extracting code from a templating language like erb or haml Prism was changed to allow these cases in ruby/prism#2741 `packwerk`ran into issue: Shopify/packwerk#400 I myself observed the same in `rubocop-erb`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is similar to davidwessman/syntax_tree-erb#81 but for RuboCop. The parser gem doesn't support these types of checks, see https://github.com/whitequark/parser?tab=readme-ov-file#syntax-check-of-block-exits
While this is technically a bug in the parser gem, it does increase compatibility and allows prism to be used when linting erb or haml through a RuboCop extension.