feat(bufformat): add comment spacing normalization#4430
Open
xingzihai wants to merge 1 commit intobufbuild:mainfrom
Open
feat(bufformat): add comment spacing normalization#4430xingzihai wants to merge 1 commit intobufbuild:mainfrom
xingzihai wants to merge 1 commit intobufbuild:mainfrom
Conversation
Normalize single-line comment spacing to ensure consistent formatting. Comments without proper spacing after // are transformed: - //no space -> // no space - //TODO: -> // TODO: This addresses issue bufbuild#4198 for comment formatting consistency. Changes: - Add normalizeCommentSpacing function in formatter.go - Add test case in formatter_test.go - Add test data for comment_spacing scenario
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
This PR implements comment spacing normalization for
buf formatas requested in issue #4198.Changes
normalizeCommentSpacingfunction informatter.gothat ensures single-line comments have a space after the//delimiterformatter_test.goto verify the behaviorBehavior
Comments without proper spacing are transformed:
//no space→// no space//TODO:→// TODO://FIXME:→// FIXME:Comments with existing proper spacing (like
// one spaceor// multiple spaces) remain unchanged.Testing
Added test case
testFormatNoDiff(t, "testdata/proto3/comment_spacing")which verifies:Related Issue
Closes #4198
This implementation was created to address the feature request for consistent comment formatting in protobuf files.