Skip to content

Commit

Permalink
Add hosting note to README
Browse files Browse the repository at this point in the history
  • Loading branch information
rcorre committed Oct 28, 2024
1 parent f0aa1d3 commit 41db9a6
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

`pbls` is a [Language Server](https://microsoft.github.io/language-server-protocol/) for [protobuf](https://protobuf.dev/).

`pbls` was originally hosted at https://git.sr.ht/~rrc/pbls, but was moved to https://github.com/rcorre/pbls ease contribution.
The sourcehut repo is maintained as a mirror.

# Features

- Diagnostics (from `protoc`)
Expand All @@ -17,7 +20,7 @@ Ensure [`protoc`](https://github.com/protocolbuffers/protobuf#protobuf-compiler-
# Installation

```
cargo install --git https://git.sr.ht/~rrc/pbls
cargo install --git https://github.com/rcorre/pbls
```

Ensure the cargo binary path (usually `~/.cargo/bin`) is on `$PATH`.
Expand Down Expand Up @@ -61,6 +64,17 @@ language-servers = ['pbls']
formatter = { command = "clang-format" , args = ["--assume-filename=a.proto"]}
```

You can also enable `pbls` in other languages, allowing you to search for protobuf messages without having a protobuf file open:

```toml
# ~/.config/helix/languages.toml

# Search for protobuf symbols in C++ files using <space>S
[[language]]
name = "cpp"
language-servers = [ "clangd", { name = "pbls", only-features = ["workspace-symbols"] } ]
```

# Similar Projects

- [buf-language-server](https://github.com/bufbuild/buf-language-server)
Expand Down

0 comments on commit 41db9a6

Please sign in to comment.