SEC-283: Remove extra whitespace after prefix when writing comments #241
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
DABH
approved these changes
Jul 30, 2019
Contributor
DABH
left a comment
DABH
left a comment
There was a problem hiding this comment.
It sounds like the real ask here would be to not change commented lines at all. But if this change results in fewer changes than the current state, then sounds good to me.
Member
Author
|
I've posted a PR to preserve whitespace on all commented lines to the upstream library magiconair/properties. I've also made corresponding changes on my cli branch. If this PR isn't enough, then once the upstream accepts my preserveFormatting changes, I'll post my branch as a PR. |
Contributor
|
@arvindth oh cool, yeah this is what we talked about on slack, I see ; ) Sounds good -- we can wait a few days and see if they accept the PR |
Member
Author
|
Closing due to a more comprehensive fix in PR #260 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
From SEC-283, it looks like we don't want the extra whitespace added after comment prefixes. If that is the only issue, then this change will fix it. Before this change:
would change to
After this change though, the original file would change to:
Note that although comment1 has retained its original spacing, the whitespace between comment2 and its prefix gets stripped out. To retain and passthrough all such formatting would require additional changes to the underlying properties parser library.