language-servers/roc
1
0
Fork 0
mirror of https://github.com/roc-lang/roc.git synced 2025-09-28 22:34:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

Update roc_ls docs

Browse source 
Signed-off-by: Anton-4 <17049058+Anton-4@users.noreply.github.com>
This commit is contained in:
Anton-4 2023-12-15 16:27:37 +01:00 • committed by GitHub
parent 9ba7f0f667
commit dc677bd86a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

27
crates/lang_srv/README.md
View file

@ -1,14 +1,11 @@
# roc_ls # roc_ls
This is a rudimentary language server for supporting basic editor usage in Roc. This is a basic language server for Roc.
Support for the following LSP features are provided: Support for the following LSP features are provided:
- Inline diagnostics - Inline diagnostics
- Hover support to get types of values - Hover to view type of value
- Go-to-definition - Go-to-definition
- <details><summary>Example</summary> - <details><summary>Example</summary>
@ -29,26 +26,28 @@ Support for the following LSP features are provided:
</details> </details>
Semantic highlighting will also be added soon. Additional features require [Semantic highlighting](https://github.com/microsoft/vscode/wiki/Semantic-Highlighting-Overview#what-is-the-difference-between-syntax-and-semantic-highlighting) will be added soon. Additional features require
changes to the compiler infrastructure that are not yet available. changes to the compiler infrastructure that are not yet available.
Note that the language server is a bit naive: Note that the language server is a bit naïve:
- If you make a change in a dependency, you'll need to also make a change in - If you make a change in a dependency, you'll also need to make a change in
the dependents' files for the changes to be picked up the dependents' files for the changes to be picked up.
- The language server will only operate on changes that are also reflected on - The language server will only operate on changes on save, auto-saving is recommended.
disk (so save often)
## Installing ## Installing
At this time, only from-source installations of the binary are supported. The roc_lang_server binary is included with the [nightly releases](https://github.com/roc-lang/roc/releases). We recommend using the same version of roc and roc_lang_server.
Follow the [installation from source](https://github.com/roc-lang/roc/tree/main/getting_started#installation) instructions. Then run ### Building from source
Follow the [building from source](https://github.com/roc-lang/roc/blob/main/BUILDING_FROM_SOURCE.md) instructions for roc. Then run:
``` ```
# do `nix develop` first if you're using nix!
cargo build -p roc_lang_srv --release cargo build -p roc_lang_srv --release
``` ```
which will give you a language server binary at This will give you the language server binary at:
``` ```
target/release/roc_ls target/release/roc_ls