https://github.com/emicklei/proto

parser for Google ProtocolBuffers definition
https://github.com/emicklei/proto

formatter golang-package parser proto2 proto3 protobuf protobuf-parser protocol-buffers

Last synced: 9 months ago
JSON representation

parser for Google ProtocolBuffers definition

• Host: GitHub
• URL: https://github.com/emicklei/proto
• Owner: emicklei
• License: mit
• Created: 2017-01-26T21:30:48.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-12-18T12:28:02.000Z (about 1 year ago)
• Last Synced: 2025-04-24T01:55:38.039Z (9 months ago)
• Topics: formatter, golang-package, parser, proto2, proto3, protobuf, protobuf-parser, protocol-buffers
• Language: Go
• Homepage:
• Size: 1.34 MB
• Stars: 601
• Watchers: 10
• Forks: 67
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - proto

README

          
# proto

[![Go](https://github.com/emicklei/proto/actions/workflows/go.yml/badge.svg)](https://github.com/emicklei/proto/actions/workflows/go.yml)

[![Go Report Card](https://goreportcard.com/badge/github.com/emicklei/proto)](https://goreportcard.com/report/github.com/emicklei/proto)

[![GoDoc](https://pkg.go.dev/badge/github.com/emicklei/proto)](https://pkg.go.dev/github.com/emicklei/proto)

[![codecov](https://codecov.io/gh/emicklei/proto/branch/master/graph/badge.svg)](https://codecov.io/gh/emicklei/proto)

Package in Go for parsing Google Protocol Buffers [.proto files version 2 + 3](https://developers.google.com/protocol-buffers/docs/reference/proto3-spec)

### install

    go get -u -v github.com/emicklei/proto

### usage

	package main

	import (

		"fmt"

		"os"

		"github.com/emicklei/proto"

	)

	func main() {

		reader, _ := os.Open("test.proto")

		defer reader.Close()

		parser := proto.NewParser(reader)

		definition, _ := parser.Parse()

		proto.Walk(definition,

			proto.WithService(handleService),

			proto.WithMessage(handleMessage))

	}

	func handleService(s *proto.Service) {

		fmt.Println(s.Name)

	}

	func handleMessage(m *proto.Message) {

		lister := new(optionLister)

		for _, each := range m.Elements {

			each.Accept(lister)

		}

		fmt.Println(m.Name)

	}

	type optionLister struct {

		proto.NoopVisitor

	}

	func (l optionLister) VisitOption(o *proto.Option) {

		fmt.Println(o.Name)

	}

### validation

Current parser implementation is not completely validating `.proto` definitions.

In many but not all cases, the parser will report syntax errors when reading unexpected charaters or tokens.

Use some linting tools (e.g. https://github.com/uber/prototool) or `protoc` for full validation.

### contributions

See [proto-contrib](https://github.com/emicklei/proto-contrib) for other contributions on top of this package such as protofmt, proto2xsd and proto2gql.

[protobuf2map](https://github.com/emicklei/protobuf2map) is a small package for inspecting serialized protobuf messages using its `.proto` definition.

© 2017-2022, [ernestmicklei.com](http://ernestmicklei.com).  MIT License. Contributions welcome.