Skip to content

jeongukjae/vscode-protobuf

Repository files navigation

vscode-protobuf

vscode-protobuf provides additional features for editing Protocol Buffers and its Text Format.

codecov

Features

  • Syntax highlighting for Protocol Buffers and Text Format.
  • Diagnostic messages (compile & lint) for Protocol Buffers. (protoc, buf, api-linter)
  • Code formatting for Protocol Buffers and Text Format. (clang-format & buf for Protocol Buffers, txtpbfmt for Text Format)
  • Symbol provider for Protocol Buffers and Text Format.
  • Go to definition for Protocol Buffers.

Extension Settings

This extension contributes the following settings:

Setting Description Default
protobuf3.compiler.provider The compiler to use for compiling Protocol Buffers 3 files. protoc
protobuf3.format.provider The formatter to use for formatting Protocol Buffers 3 files. clang-format
protobuf3.protoc.executable The path to the protoc executable. protoc
protobuf3.protoc.arguments The arguments to pass to protoc. []
protobuf3.api-linter.enabled Whether to enable api-linter. false
protobuf3.api-linter.executable The path to the api-linter executable. api-linter
protobuf3.api-linter.arguments The arguments to pass to api-linter. []
protobuf3.buf.lint.enabled Whether to enable buf lint. false
protobuf3.buf.executable The path to the buf executable. buf
protobuf3.buf.arguments The arguments to pass to buf. []
protobuf3.clang-format.executable The path to the clang-format executable. clang-format
protobuf3.clang-format.arguments The arguments to pass to clang-format. ['-style=google']
textproto.format.provider The formatter to use for formatting Protocol Buffers Text Format files. txtpbfmt
textproto.txtpbfmt.executable The path to the txtpbfmt executable. txtpbfmt
textproto.txtpbfmt.arguments The arguments to pass to txtpbfmt. []

TODO

TODOs are tracked in GitHub issues

Release Notes

Check CHANGELOG.md