VSCodeでprotoファイルのフォーマットをする

3313 ワード

VS Code Protocol Buffers tech テキストリンク

やりたいこと

VSCodeでprotoファイルを編集する時に保存時に自動でフォーマットすること

$ brew install clang-format

以下のプラグインをインストールします。

settings.json

    "protoc": {
        "editor.formatOnSave": true
    },

フォーマットの指定については以下のようにできます。

settings.json

    "clang-format.language.proto.style": "google",

settings.json

    "clang-format.language.proto.style": "{ IndentWidth: 4, BasedOnStyle: Google }",

または .clang-format ファイルをプロジェクトのルートディレクトリに置くとその設定が使われます。
.clang-format を１から書くのは難しいので生成したものをカスタマイズするのがよさそうです。
以下のようにコマンドを打つと生成できます。

$ clang-format -dump-config -style=Google > .clang-format

ここがちょっとハマった点でこれを書かないと保存時にフォーマットされませんでした。

settings.json

    "[proto3]": {
        "editor.defaultFormatter": "xaver.clang-format",
    }

これでフォーマットが自動でできるようになりました。

この問題について(VSCodeでprotoファイルのフォーマットをする), 我々は、より多くの情報をここで見つけました https://zenn.dev/y16ra/articles/2a88926f71a744

著者帰属：元の著者の情報は、元のURLに含まれています。著作権は原作者に属する。

Collection and Share based on the CC protocol