Comments (2)
I have thought about writing out proto files from a descriptor. I agree it would be a neat feature.
Making it lossless, for cases where source_code_info
is present, is actually very complicated because of the way the source_code_info
models language elements and file locations. Also, the way extra comments are represented, like inline comments between elements, makes it really hard to preserve all comments in the output. For example:
message Foo {
/* comment 1 */ optional /* comment 2 */ /* comment 3 */ string
// yet another comment
fieldNameBar = /* more comments */ 3 [ /* some option comments! */ default =
// another line comment, inside options
"baz" ]/* another one! */ ; // trailer
}
I believe there is enough info in source_code_info
to be aware of all of the comments, but not enough to actually preserve formatting and placement.
I have seriously looked at preserving comments in the protoparse
package. It is a hefty change that would involve quite a lot of boiler-plate -- wrapping every value in the parse tree with a new struct that includes position information and comments. There would also be some non-trivial work to make sure comments are attributed to elements correctly (to match protoc behavior).
I'll add this as a separate issue.
from protoreflect.
Feature implemented in #84
from protoreflect.
Related Issues (20)
- Protoreflect doesn't fall back to to v1alpha when a gRPC unimplemented response is returned HOT 1
- String escaping in protoprint is wrong HOT 1
- First enum value must be 0 in proto3 [protoprint] HOT 2
- missing `{}` after printing option HOT 5
- Upgrade protocompile to v0.7.0 HOT 3
- go build error HOT 3
- Regression upgrading from v1.14.1 to v1.15.4: extensions are resolved recursively instead of non-recursively HOT 1
- Regression upgrading from v1.14.1 to v1.15.4: absolute paths no longer accepted by parser.ParseFilesButDoNotLink HOT 3
- Regression upgrading from v1.14.1 to v1.15.4: new mustBeSource constraint/check HOT 5
- Stub structure and Methods will relay on protobuf API V2 HOT 15
- Fail to compile proto file HOT 2
- Tests broken with google.golang.org/protobuf v1.33.0
- If there are messages nested in the proto file, the numbers will be recognised as strings HOT 2
- invalid memory address or nil pointer dereference HOT 5
- will return Symbol not found when the proto file has enum definition HOT 1
- Is there a way to UseProtoNames? HOT 2
- desc/builder: feature request: auto-de-duplicate builders and already-built descriptors in transitive graph HOT 4
- NPE from sourceinfo wrapping logic
- Optional fields are considered oneofs? HOT 2
- ParseFilesButDoNotLink panics in option validation with invalid .proto HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from protoreflect.