Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ghostiam/protogetter
Protobuf golang linter - use getters instead of fields.
https://github.com/ghostiam/protogetter
golang golang-grpc golang-linter grpc-go linter protobuf
Last synced: 1 day ago
JSON representation
Protobuf golang linter - use getters instead of fields.
- Host: GitHub
- URL: https://github.com/ghostiam/protogetter
- Owner: ghostiam
- License: mit
- Created: 2023-09-06T01:19:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-11T16:01:31.000Z (3 months ago)
- Last Synced: 2024-12-15T14:07:30.635Z (8 days ago)
- Topics: golang, golang-grpc, golang-linter, grpc-go, linter, protobuf
- Language: Go
- Homepage:
- Size: 87.9 KB
- Stars: 23
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Protogetter
Welcome to the Protogetter project!
## Overview
Protogetter is a linter developed specifically for Go programmers working with nested `protobuf` types.\
It's designed to aid developers in preventing `invalid memory address or nil pointer dereference` errors arising from direct access of nested `protobuf` fields.
When working with `protobuf`, it's quite common to have complex structures where a message field is contained within another message, which itself can be part of another message, and so on.
If these fields are accessed directly and some field in the call chain will not be initialized, it can result in application panic.
Protogetter addresses this issue by suggesting use of getter methods for field access.
## How does it work?
Protogetter analyzes your Go code and helps detect direct `protobuf` field accesses that could give rise to panic.\
The linter suggests using getters:
```go
m.GetFoo().GetBar().GetBaz()
```
instead of direct field access:
```go
m.Foo.Bar.Baz
```
And you will then only need to perform a nil check after the final call:
```go
if m.GetFoo().GetBar().GetBaz() != nil {
// Do something with m.GetFoo().GetBar().GetBaz()
}
```
instead of:
```go
if m.Foo != nil {
if m.Foo.Bar != nil {
if m.Foo.Bar.Baz != nil {
// Do something with m.Foo.Bar.Baz
}
}
}
```
or use zero values:
```go
// If one of the methods returns `nil` we will receive 0 instead of panic.
v := m.GetFoo().GetBar().GetBaz().GetInt()
```
instead of panic:
```go
// If at least one structure in the chains is not initialized, we will get a panic.
v := m.Foo.Bar.Baz.Int
```
which simplifies the code and makes it more reliable.
## Installation
```bash
go install github.com/ghostiam/protogetter/cmd/protogetter@latest
```
## Usage
To run the linter:
```bash
protogetter ./...
```
Or to apply suggested fixes directly:
```bash
protogetter --fix ./...
```