Respect SyntaxVisitorContinueKind of rules when run in Pipeline #659
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
Add a map `shouldSkipChildren` that tracks which rules are currently skipping children. Install handlers in visitPost for each rule that determine when we should start visiting children again (when we leave the node we're skipping).
Previously we only tested the rule in isolation. This mean we weren't actually checking the pipeline respected the SyntaxVisitorContinueKind. Regardless of what the pipeline did, the tests would respect the continue kind because they run the rule itself. Now we run the rule in isolation and the pipeline and assert that they have the same findings. This ensures the rule behaves as expected (or atleast as tested) when run in the pipeline.
allevato
approved these changes
Oct 26, 2023
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.
Pipelines+Generated.swift previously visited all enabled rules at all nodes regardless of what the rule returned for it's
SyntaxVisitorContinueKind. However, some rules rely on returning.skipChildrento lint/format correctly.To remedy this, modify the pipeline to track the the skip state of each rule. When a rule returns skip, our pipeline stops calling its visit methods until we leave the skipped node.
Alongside this change, modify tests to check both the rule in isolation and the pipeline. We were only testing the rule in isolation so our tests were respecting the
SyntaxVisitorContinueKind, even though our pipeline was not.