# protoc-gen-ego

**Repository Path**: wizacklabs/protoc-gen-ego

## Basic Information

- **Project Name**: protoc-gen-ego
- **Description**: An extended go protobuffers generating plugin, which can customize message field name, struct tags, and CamelCase formatted enum constant name.
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2025-05-30
- **Last Updated**: 2025-08-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: protobuf, protoc-gen-go, protobuffers, JSON, gorm

## README

# protc-gen-ego

The protoc-gen-ego project is another protoc plugin to generate Go code for both proto2 and proto3 versions of the protocol buffer language. 

The protoc-gen-ego works just like official plugin, and provides some new features to auto generate message field tag and customized field name from comments, and CamelCase formatted enum constants name 

For more information about the usage of this plugin, see: https://protobuf.dev/reference/go/go-generated.

## Features
- auto generate message field tags from comments
- customize message field name
- generate CamelCase formatted enum constants name

## Limitations
- only works for message field declaration

## Installation
```bash
go install gitee.com/wizacklabs/proto-gen-ego
```

## Usage
### General Command Line Arguments
```bash
protoc --plugin=protoc-gen-ego --ego_out=. --ego_opt=paths=source_relative xxx/xxx.proto
```

### Generate CamelCase Enum Constants
- protobuf source code
```protobuf
enum Role {
  UNSPECIFIC      = 0;
  CREATOR         = 1;
  OWNER           = 2;
  FINANCE_MANAGER = 3;
}
```
- generate option
```bash
protoc --plugin=protoc-gen-ego --ego_out=enum=camelcase:. --ego_opt=paths=source_relative xxx/xxx.proto
```

- generated go source code
```go
type Role int32

const (
	RoleUnspecific     Role = 0
	RoleCreator        Role = 1
	RoleOwner          Role = 2
	RoleFinanceManager Role = 3
)
```

### Generate Field Tags
    
- protobuf source code
```protobuf
message foo {
    // @gorm.tag=column:id;autoIncrement
    // @json.tag=ID
    int64 id = 1;
}
```
- generated go source code
```go
type Foo struct {
    state         protoimpl.MessageState
    sizeCache     protoimpl.SizeCache
    unknownFields protoimpl.UnknownFields

    Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"ID,omitempty" gorm:"column:id;autoIncrement"`
}
```

### Customize Field Name
- protobuf source code
```protobuf
message foo {
    // @go.name=ID
    int64 id = 1;
}
```
- generated go source code
```go
type Foo struct {
    state         protoimpl.MessageState
    sizeCache     protoimpl.SizeCache
    unknownFields protoimpl.UnknownFields

    ID int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
}
```