運営者情報

運営してるひと: @sters9

       

妻と猫と横浜あたりに住んでいる。最近は Go や Kubernetes や GCP をしています。 PHP や JavaScript もすこし。

プライバシーポリシー

tools.gomiba.co

アーカイブ

2021/02 (12) 2021/01 (8)

2020/05 (2) 2020/04 (2) 2020/02 (2) 2020/01 (1)

2019/12 (3) 2019/11 (2) 2019/10 (5) 2019/09 (3) 2019/07 (6) 2019/06 (4) 2019/04 (3) 2019/01 (2)

2018/12 (6) 2018/10 (4) 2018/09 (6) 2018/08 (7) 2018/07 (16) 2018/06 (7) 2018/05 (7) 2018/04 (5) 2018/03 (3) 2018/02 (10) 2018/01 (6)

2017/12 (8) 2017/11 (6) 2017/10 (10) 2017/09 (12) 2017/08 (12) 2017/07 (3) 2017/06 (1) 2017/01 (4)

2016/12 (5) 2016/10 (3) 2016/09 (1) 2016/07 (2) 2016/06 (1) 2016/04 (1) 2016/02 (1) 2016/01 (2)

2015/12 (1) 2015/10 (1) 2015/09 (3) 2015/06 (1) 2015/01 (1)

2014/08 (2) 2014/07 (3) 2014/05 (1) 2014/01 (7)

2013/12 (2) 2013/11 (4) 2013/10 (1) 2013/09 (1) 2013/08 (3) 2013/07 (4) 2013/06 (5) 2013/05 (2) 2013/04 (7) 2013/03 (1)

.proto を整形する

この記事は公開されてから1年以上経過しており、情報が古くなっている可能性があります。

.proto ってどうやって整形するんだろう?って思ったら Issue がヒット。

proto file formatter · Issue #4113 · google/protobuf

clang-format を使えってことみたいなので、やってみる。 

Mac なら brew で入る。

$ brew install clang-format
$ clang-format -i hoge.proto

JetBrains 系エディタなら clang-format プラグインがあって Reformat Code with clang-format というコマンドが増えるので、これを実行すると OK 内部的に clang-format を実行するので、実行できる状態になっている必要がある。

vscode にも同様の動きをするような Clang-Format という拡張機能があるのでこれを使うと整形が出来る。 と思ったが .proto には紐付いてないみたいなのでダメっぽい…?

とはいえ環境を汚したくないとか、何かしらの都合で入れられないとかあると思うので Docker 使って make なりのタスクランナーから実行出来るようにしてあげるのがいいかな。

Dockerfile はこんな様子で。

FROM alpine:3.8

RUN apk add clang findutils

ENTRYPOINT find . -type f | xargs clang-format -i

run はこんなふうにやる。

$ docker run --rm -t -w /work -v "$(pwd)":/work clang-format

というのを試したリポジトリはココ。

sters/docker-clang-format-example: testrepo

ガタガタな proto も整えてくれる。

Before

syntax = "proto3";

package example;

import "google/protobuf/timestamp.proto";




service Example {
    rpc Get(GetRequest) returns (GetResponse) {};
}

message GetRequest {
    string fieldA;
            int fieldB;
google.protobuf.Timestamp fieldC;
}

message GetRequest {
string a;
    repeated google.protobuf.Timestamp b;
}

After

syntax = "proto3";

package example;

import "google/protobuf/timestamp.proto";

service Example {
  rpc Get(GetRequest) returns (GetResponse) {};
}

message GetRequest {
  string fieldA;
  int fieldB;
  google.protobuf.Timestamp fieldC;
}

message GetRequest {
  string a;
  repeated google.protobuf.Timestamp b;
}