Respect comment ignores on proto2 group fields#4484
Open
lawrence3699 wants to merge 1 commit intobufbuild:mainfrom
Open
Respect comment ignores on proto2 group fields#4484lawrence3699 wants to merge 1 commit intobufbuild:mainfrom
lawrence3699 wants to merge 1 commit intobufbuild:mainfrom
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
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.
Fixes #4187
For proto2 group declarations, leading comments are attached to the synthetic nested message source location instead of the group field source location. That meant
// buf:lint:ignore FIELD_NOT_REQUIREDon a required group declaration was still ignored even though the same comment worked on a normal required field.This updates comment-ignore lookup to also check sibling source paths that share the same source span, which covers the field/synthetic-message pair for groups, and adds a regression test for the required-group case.
Validation:
go test ./private/bufpkg/bufcheck -run 'TestRunComments|TestRunFieldNotRequired(GroupCommentIgnore)?$' -count=1\n-go run ./cmd/buf lint /tmp/buf-group-ignore-eYGbo9 --error-format=json