Coder Social home page Coder Social logo

protog's Introduction

protog

GoDoc Go Report Card

Protobuf file generator for the command line.

Installation

go get github.com/mvrilo/protog/cmd/protog

Usage

$ protog -h
protog is a protobuf file generator for the command line

Usage:
  protog <name> [-dhfomnsp] [-n option_name:proto_name] [-m MessageName[field:type,field:type,...]] [-s ServiceName[MethodName:In:Out]]

Examples:
protog Greet.v1 -m HelloRequest[data:string]

Flags:
  -d, --dryrun                prints the generated proto to stdout
  -f, --force                 overwrite the file if it already exists
  -h, --help                  help for protog
  -m, --message stringArray   add a message and its fields
  -n, --option strings        add an option
  -o, --output string         output dir for the generated proto (default ".")
  -p, --package string        package name
  -s, --service stringArray   add a service and its methods
  -v, --version               version for protog

Example Usage

Given the input:

protog Greet.v1 \
    -n go_package:greet \
    -m HelloRequest[data:string] \
    -m HelloResponse[id:int64,data:string] \
    -s HelloService[SendHello:HelloRequest:HelloResponse,CheckHello] \
    -s PingService[SendPing:PingRequest:+PingResponse]

You should get the file greet.v1.proto with the content:

syntax = "proto3";

package Greet.v1;

option "go_package" = "greet";

import "google/protobuf/empty.proto";

message HelloRequest {
	string data = 1;
}

message HelloResponse {
	string data = 1;
	int64 id = 2;
}

service HelloService {
	rpc SendHello (HelloRequest) returns (HelloResponse) {};
	rpc CheckHello (google.protobuf.Empty) returns (google.protobuf.Empty) {};
}

service PingService {
	rpc SendPing (PingRequest) returns (stream PingResponse) {};
}

Author

Murilo Santana <[email protected]>

License

MIT

protog's People

Contributors

mvrilo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.