https://github.com/mvrilo/protoc-gen-d2

protoc-gen-d2 is a plugin for Google's Protocol Buffers (protoc) that generates svg of the entities specified in the proto files
https://github.com/mvrilo/protoc-gen-d2

diagram go golang grpc protobuf protoc protoc-gen protocol-buffers svg

Last synced: 4 months ago
JSON representation

protoc-gen-d2 is a plugin for Google's Protocol Buffers (protoc) that generates svg of the entities specified in the proto files

• Host: GitHub
• URL: https://github.com/mvrilo/protoc-gen-d2
• Owner: mvrilo
• License: mit
• Created: 2023-02-22T13:52:45.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-27T14:54:14.000Z (almost 2 years ago)
• Last Synced: 2024-10-06T17:04:06.882Z (4 months ago)
• Topics: diagram, go, golang, grpc, protobuf, protoc, protoc-gen, protocol-buffers, svg
• Language: Go
• Homepage:
• Size: 229 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# protoc-gen-d2

[![Go Report Card](https://goreportcard.com/badge/github.com/mvrilo/protoc-gen-d2)](https://goreportcard.com/report/github.com/mvrilo/protoc-gen-d2)

`protoc-gen-d2` is a plugin for Google's Protocol Buffers (`protoc`) that generates svg of the entities specified in the `proto` files. The idea is to improve a project documentation with a visual representation of the data.

## Example

Given a proto such as:

```proto

syntax="proto3";

package example;

enum Status {

    ACTIVE = 0;

    INACTIVE = 1;

}

message Phone {

    string number = 1;

}

message User {

    string name = 1;

    string email = 2;

    Phone phone = 3;

    Status status = 4;

}

message UserRequest {

    string name = 1;

}

service UserService {

    rpc GetUser (UserRequest) returns (User);

}

```

Run the `protoc` with `protoc-gen-d2`:

```

protoc \

    -I ./testdata/proto \

    --plugin=protoc-gen-d2=./protoc-gen-d2 \

    --d2_out="testdata/generated/" \

    ./testdata/proto/hello.proto

```

Result:

[![example](testdata/generated/example.svg)](https://github.com/mvrilo/protoc-gen-d2/blob/master/testdata/generated/example.svg)

## LICENSE

MIT