Refactor the diagnostic renderer to avoid printing trailing whitespace #430
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
emcfarlane
previously approved these changes
Jan 31, 2025
jhump
reviewed
Jan 31, 2025
experimental/parser/testdata/lexer/braces/interleaved.proto.stderr.txt
Outdated
Show resolved
Hide resolved
jhump
reviewed
Jan 31, 2025
experimental/report/writer.go
Outdated
| return len(data), nil | ||
| } | ||
|
|
||
| func (w *writer) WriteBytes(b byte, n int) { |
There was a problem hiding this comment.
I think passing b = '\n' breaks this thing. This is only ever called with a space. How about instead just name it WritePadding(n int) and hardcode the space?
There was a problem hiding this comment.
Don't think b = '\n' breaks as the same WriteString("\n\n\n") would append \n\n\n to the buffer, just looping over and checking for right padding between each newline.
There was a problem hiding this comment.
No, Josh is right. Plus, having it only print spaces means we can make it more efficient.
doriable
reviewed
Feb 3, 2025
doriable
reviewed
Feb 3, 2025
doriable
reviewed
Feb 3, 2025
emcfarlane
reviewed
Feb 4, 2025
emcfarlane
approved these changes
Feb 4, 2025
doriable
approved these changes
Feb 4, 2025
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 PR refactors the renderer so that all writes go through a shared state type, to ensure fine control over whitespace and line endings. This is also an opportunity to somewhat better organize how values are passed between functions in the renderer.