protoc-go-remove-enum-prefix

README

protoc-go-remove-enum-prefix

Why?

Golang protobuf adds type prefix to generated constants that makes code harder to read and follow with longer enums (both longer type name and longer enum values). See protoc-gen-go: remove type name from generated enum. This tool removes that prefix in generated *.pb.go.

Special thanks

Special thanks to Diep Pham, code of that util based on his protoc-go-inject-tag.

Install

• protobuf version 3

  For OS X:

  brew install protobuf
  

• go support for protobuf: go get -u github.com/golang/protobuf/{proto,protoc-gen-go}

• go install github.com/kluevandrew/protoc-go-remove-enum-prefix or download the binaries from the releases page.

Usage

$ protoc-go-remove-enum-prefix -h
Usage of protoc-go-remove-enum-prefix:
  -input string
        pattern to match input file(s)
  -verbose
        verbose logging

Add a comment with the following syntax before enums, and prefixes on all associated constants in resulting .pb.go file would be removed.

// @go-enum-no-prefix

Example

// file: test.proto
syntax = "proto3";

package pb;
option go_package = "/pb";

// @go-enum-no-prefix
enum SomeEnum {
  SOME_ENUM_UNSPECIFIED = 0;
  SOME_ENUM_ONE = 1;
  SOME_ENUM_TWO = 2;
}

message SomeMessage {
  string id = 1;
  SomeEnum type = 2;
}

Generate your .pb.go files with the protoc command as normal:

protoc --proto_path=. --go_out=paths=source_relative:. test.proto

Then run protoc-go-remove-enum-prefix against the generated files (e.g test.pb.go):

$ protoc-go-remove-enum-prefix -input=./test.pb.go
# or
$ protoc-go-remove-enum-prefix -input="*.pb.go"

The resulted code will be in test.pb.go:

type SomeEnum int32

const (
  SOME_ENUM_UNSPECIFIED SomeEnum = 0
  SOME_ENUM_ONE         SomeEnum = 1
  SOME_ENUM_TWO         SomeEnum = 2
)