Test snapshots with inline checks #681
Closed
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
Idea here is to make it easier to visually confirm that the checks are in the right location. When developing lints, I had to "manually" transfer the location (row, column) from the existing snapshot to the original source file fixture. This also serves as a first step toward better reporting with source code.
Move up the end location of the check to the nearest non-empty line. This removes trailing empty lines from the range of code the check is reporting.
|
For narrowing down I need to check whether this is actually necessary or, in case the end points to the start of a line, I'll just report the end of the check for the line before. Might just be being confused by the locations. |
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 a massive diff because I'm introducing new snapshots. The first and third commit are the relevant ones. To motivate this a bit:
When developing new lints or checking existing lints, I did one of these two things:
I also noticed that some test fixtures have inline comments/decorators to clarify what is expected.
What I'm doing here is to add a new snapshot (to potentially replace the existing one eventually) that inlines the checks into the source code, similar to what we'd expect with #525 (which I've been looking into, hence this first step).
Looking at these snapshots it's easier to visually confirm the correct location (currently just row based though).
What I did notice is that in some cases the end location is pretty far off, due to whitespace following it. The third commit is an attempt to narrow down this location to have a closer match.
Example initial snapshot
Example snapshot with narrowed down location