Peter Tripp
f30de4852a
Fixes docs to reflect that Protobuf support is via extension. Comment out references ProtoLS formatter. Need to test both protols and protobuf-language-server to ensure both work.
80 lines
1.6 KiB
Markdown
80 lines
1.6 KiB
Markdown
# Proto
|
|
|
|
Proto/proto3 (Protocol Buffers definition language) support is available through the [Proto extension](https://github.com/zed-industries/zed/tree/main/extensions/proto).
|
|
|
|
- Tree Sitter: [coder3101/tree-sitter-proto](https://github.com/coder3101/tree-sitter-proto)
|
|
- Language Servers: [protobuf-language-server](https://github.com/lasorda/protobuf-language-server)
|
|
|
|
<!--
|
|
TBD: Clarify which language server(s) to use / Feature support.
|
|
|
|
## Setup
|
|
|
|
### Install protobuf-language-server
|
|
|
|
Install protobuf-language-server and make sure it's in your PATH:
|
|
|
|
```
|
|
go install github.com/lasorda/protobuf-language-server@latest
|
|
which protobuf-language-server
|
|
```
|
|
|
|
### Install ProtoLS
|
|
|
|
Install protols and make sure it's in your PATH:
|
|
|
|
```
|
|
cargo install protols
|
|
which protols
|
|
```
|
|
|
|
## Configuration
|
|
|
|
```json
|
|
"lsp": {
|
|
"protobuf-language-server": {
|
|
"binary": {
|
|
"path": "protols"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## Formatting
|
|
|
|
ProtoLS supports formatting if you have `clang-format` installed.
|
|
|
|
```sh
|
|
# MacOS:
|
|
brew install clang-format
|
|
# Ubuntu
|
|
sudo apt-get install clang-format
|
|
# Fedora
|
|
sudo dnf install clang-tools-extra
|
|
```
|
|
|
|
To customize your formatting preferences, create a `.clang-format` file, e.g.:
|
|
|
|
```clang-format
|
|
IndentWidth: 4
|
|
ColumnLimit: 120
|
|
```
|
|
|
|
Or you can have zed directly invoke `clang-format` by specifying it as a [formatter](https://zed.dev/docs/configuring-zed#formatter) in your settings:
|
|
|
|
```json
|
|
"languages": {
|
|
"Proto": {
|
|
"format_on_save": "on",
|
|
"tab_size": 4,
|
|
"formatter": {
|
|
"external": {
|
|
"command": "clang-format",
|
|
"arguments": ["-style={IndentWidth: 4, ColumnLimit: 0}"]
|
|
}
|
|
}
|
|
},
|
|
}
|
|
```
|
|
-->
|