Protols is an open-source Language Server Protocol (LSP) for proto files, powered by the robust and efficient tree-sitter parser. With Protols, you get powerful code assistance for protobuf files, including auto-completion, syntax diagnostics, and more.
- ✅ Code Completion
- ✅ Diagnostics
- ✅ Document Symbols
- ✅ Code Formatting
- ✅ Go to Definition
- ✅ Hover Information
- ✅ Rename Symbols
- ✅ Find references
To install Protols, run:
cargo install protolsThen, configure it with nvim-lspconfig:
require'lspconfig'.protols.setup{}You can use the Protobuf Language Support extension, which leverages this LSP under the hood.
Note: This extension is open source but is not maintained by us.
Protols provides intelligent autocompletion for messages, enums, and proto3 keywords within the current package.
Diagnostics are powered by the tree-sitter parser, which catches syntax errors but does not utilize protoc for more advanced error reporting.
Formatting is enabled if clang-format is available. You can control the formatting style by placing a .clang-format file in the root of your workspace. Both document and range formatting are supported.
Provides symbols for the entire document, including nested symbols, messages, and enums.
Jump to the definition of any custom symbol, even across package boundaries.
Displays comments and documentation for protobuf symbols on hover. Works seamlessly across package boundaries.
Allows renaming of symbols like messages and enums, along with all their usages across packages. Currently, renaming fields within symbols is not supported directly.
Allows user defined types like messages and enums can be checked for references. Nested fields are completely supported.
Protols is designed to supercharge your workflow with proto files. We welcome contributions and feedback from the community! Feel free to check out the repository and join in on improving this tool! 🎉