inspired by PGV
Generate custom description for proto enum
go install github.com/windmeup/protoc-gen-enum-desc/cmd/protoc-gen-enum-desc@latestimport "pged/enumdesc.proto"; // proto files in GO_HOME/pkg/mode/github.com/windmeup/...
enum ClientEvent {
option (pged.default_description) = "unknown client event"; // default description, optional
CLIENT_EVENT_UNSPECIFIED = 0;
CLIENT_EVENT_START = 1 [(pged.description) = "client start"]; // description, optional
CLIENT_EVENT_STOP = 2;
}protoc \
-I . \
-I path/to/pged/ \
--go_out=":../generated" \
--enum-desc_out="lang=go:../generated" \
example.protoGenerate code with buf, recommend
# buf.yaml
version: v1
deps:
- buf.build/windmeup/pged
breaking:
use:
- FILE
lint:
use:
- DEFAULT# buf.gen.yaml
version: v1
plugins:
- name: go
out: .
opt: paths=source_relative
- name: enum-desc
out: .
opt:
- paths=source_relative
- lang=gobuf mod update
buf generate- go module
go get github.com/windmeup/protoc-gen-enum-desc- get enum's description with Description() methods, which in generated files xxxxxx.pb.enumdesc.go
package example
import (
"github.com/stretchr/testify/require"
"testing"
)
func TestClient_ClientEvent_Description(t *testing.T) {
require.Equal(t, "client start", Client_CLIENT_EVENT_START.Description())
}TODO