Compact single-message option syntax in proto#1
Merged
tomlinford merged 1 commit intoNov 8, 2025
Merged
Conversation
Add support for compact dot notation syntax for field options with
single-field nested messages. This makes option declarations more
readable and concise.
Examples:
- Before: [(buf.validate.field) = {int32: {gte: 2020}}]
- After: [(buf.validate.field).int32.gte = 2020]
- Before: [(validate.rules) = {string: {uuid: true}}]
- After: [(validate.rules).string.uuid = true]
Implementation:
- Add flattenSingleFieldPath() to recursively detect and flatten
single-field nested maps into dot-separated paths
- Update addShortOptions() to apply flattening to field options
- Long options (option declarations) continue to use message literals
- Add comprehensive regression tests
The compact format only applies to field options (inside []), not to
long options which properly use message literal syntax:
option (google.api.http) = {get: "/users/{id}"};
Changes:
- proto_ast/ast.go: Add flattening logic in addShortOptions()
- proto_ast/ast_test.go: Add tests for nested single-field cases
- sroto_ir/example_test.go: Update expected output
- README.md: Update examples to show new compact format
- example/options_example.proto: Regenerate with compact format
- Vendor minimal set of google/protobuf protos for protoc validation
- Fix golangci-lint errcheck warnings
- Update CI: Go 1.22, protoc 3.20.0, golangci-lint latest
207f1bc to
7969cd8
Compare
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.
Add support for compact dot notation syntax for field options with single-field nested messages. This makes option declarations more readable and concise.
Examples:
Before: [(buf.validate.field) = {int32: {gte: 2020}}]
After: [(buf.validate.field).int32.gte = 2020]
Before: [(validate.rules) = {string: {uuid: true}}]
After: [(validate.rules).string.uuid = true]
Implementation:
Changes:
The compact format only applies to field options (inside []), not to long options which properly use message literal syntax:
option (google.api.http) = {get: "/users/{id}"};