feat: Add support for go to definition and hover and diagnostics on s…

…ingle file (#2) In a single file mode, the definition and hover support have been added.
coder3101 · Jun 16, 2024 · 59dc1ab · 59dc1ab
1 parent 44a7757
commit 59dc1ab
Show file tree

Hide file tree

Showing 10 changed files with 545 additions and 57 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 /target
+/logs
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -11,3 +11,6 @@ tokio-util = { version = "0.7.11", features = ["compat"] }
 tower = "0.4.13"
 tracing = "0.1.40"
 tracing-subscriber = "0.3.18"
+tree-sitter-proto = { git = "https://github.com/coder3101/tree-sitter-proto", branch = "main" }
+tree-sitter = "0.22.6"
+tracing-appender = "0.2.3"
diff --git a/README.md b/README.md
@@ -1,11 +1,20 @@
 # protols
-Language server for proto files
+A Language Server for **proto3** files. It only uses tree-sitter parser for all operations and always runs in **single file mode**.
+
+## Features 
+- [x] Hover
+- [x] Go to definition
+- [x] Diagnostics
+
+
+## Installation and testing
+
+Clone the repository and run `cargo install --path .` to install locally in your `~/.cargo/bin` and the below to your `init.lua` until we start shipping this via Mason.
 
-## Testing with neovim
 ```lua
 local client = vim.lsp.start_client({
 	name = "protols",
-	cmd = { "<absolute path to protols binary>" },
+	cmd = { vim.fn.expand("$HOME/.cargo/bin/protols") },
 })
 
 if not client then