docs: Proto Language is by extension not native (#21096)
Some checks are pending
CI / Check Postgres and Protobuf migrations, mergability (push) Waiting to run
CI / Check formatting and spelling (push) Waiting to run
CI / (macOS) Run Clippy and tests (push) Waiting to run
CI / (Linux) Run Clippy and tests (push) Waiting to run
CI / (Linux) Build Remote Server (push) Waiting to run
CI / (Windows) Run Clippy and tests (push) Waiting to run
CI / Create a macOS bundle (push) Blocked by required conditions
CI / Create a Linux bundle (push) Blocked by required conditions
CI / Create arm64 Linux bundle (push) Blocked by required conditions
CI / Auto release preview (push) Blocked by required conditions
Deploy Docs / Deploy Docs (push) Waiting to run
Docs / Check formatting (push) Waiting to run
Script / ShellCheck Scripts (push) Waiting to run

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.
This commit is contained in:
Peter Tripp 2024-11-23 06:17:39 +00:00 committed by GitHub
parent 2177e833d8
commit f30de4852a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,9 +1,44 @@
# Proto # Proto
Proto/proto3 (Protocol Buffers definition language) support is available natively in Zed. 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) - Tree Sitter: [coder3101/tree-sitter-proto](https://github.com/coder3101/tree-sitter-proto)
- Language Server: [protols](https://github.com/coder3101/protols) - 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 ## Formatting
@ -41,3 +76,4 @@ Or you can have zed directly invoke `clang-format` by specifying it as a [format
}, },
} }
``` ```
-->