https://github.com/wizacklabs/protoc-gen-go
Another protoc plugin to generate Go codes, and add customizing field tags and names support
https://github.com/wizacklabs/protoc-gen-go
gorm json protobuf protoc-gen-go
Last synced: 12 months ago
JSON representation
Another protoc plugin to generate Go codes, and add customizing field tags and names support
- Host: GitHub
- URL: https://github.com/wizacklabs/protoc-gen-go
- Owner: wizacklabs
- License: mit
- Created: 2024-09-07T03:26:12.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-21T06:50:28.000Z (almost 2 years ago)
- Last Synced: 2024-11-25T12:42:58.794Z (over 1 year ago)
- Topics: gorm, json, protobuf, protoc-gen-go
- Language: Go
- Homepage:
- Size: 20.5 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# protc-gen-go
The protoc-gen-go project is another protoc plugin to generate Go code for both proto2 and proto3 versions of the protocol buffer language.
The protoc-gen-go works just like official utility, and provides some new features to auto generate message field tag and custimize field name from comments.
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
## Limitations
- only works for message field declaration
## Installation
```bash
go install github.com/derekhjray/proto-gen-go
```
## Usage
- auto 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"`
}
```