luxolus/open-nomad
2
0
Fork 0
Code Issues 1 Pull requests Packages Releases Wiki Activity
open-nomad/tools/buf
History
Mahmood Ali 98c02851c8
use comment ignores (#9448) 
Use targetted ignore comments for the cases where we are bound by
backward compatibility.

I've left some file based linters, especially when the file is riddled
with linter voilations (e.g. enum names), or if it's a property of the
file (e.g. package and file names).

I encountered an odd behavior related to RPC_REQUEST_RESPONSE_UNIQUE and
RPC_REQUEST_STANDARD_NAME.  Apparently, if they target a `stream` type,
we must separate them into separate lines so that the ignore comment
targets the type specifically.
2020-11-25 16:03:01 -05:00
..
buf.gen.yaml proto: Switch to using buf (#9308) 2020-11-17 07:01:48 -08:00
buf.yaml use comment ignores (#9448) 2020-11-25 16:03:01 -05:00
README.md proto: Switch to using buf (#9308) 2020-11-17 07:01:48 -08:00

README.md

Buf

buf is a high-performance protoc replacement.

Installation

See installation instructions here.

Usage

make proto in the root of this repo will invoke buf using the configuration in this directory.

Why use buf instead of protoc?

Buf is a user-friendly tool to work with Protobuf that outperforms protoc in every conceivable way. It was written by the author(s) of prototool, another tool that made generating Protobuf easier, but which is now deprecated in favor of buf. Buf also does linting and breaking-change detection.