From e18661f62b884ba970f8b3267400bf4320c7b118 Mon Sep 17 00:00:00 2001 From: Veetaha Date: Sun, 9 Feb 2020 20:19:23 +0200 Subject: docs: Freshen docs for prebuilt binaries and raLspServer setting --- docs/dev/README.md | 11 +++++++++-- docs/user/README.md | 17 ++++++++++++++--- 2 files changed, 23 insertions(+), 5 deletions(-) (limited to 'docs') diff --git a/docs/dev/README.md b/docs/dev/README.md index 732e4bdd3..991deaf90 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md @@ -74,7 +74,7 @@ relevant test and execute it (VS Code includes an action for running a single test). However, launching a VS Code instance with locally build language server is -possible. There's "Run Extension (Dev Server)" launch configuration for this. +possible. There's **"Run Extension (Dev Server)"** launch configuration for this. In general, I use one of the following workflows for fixing bugs and implementing features. @@ -88,7 +88,14 @@ Code to sanity check that the thing works as I expect. If the problem concerns only the VS Code extension, I use **Run Extension** launch configuration from `launch.json`. Notably, this uses the usual -`ra_lsp_server` binary from `PATH`. After I am done with the fix, I use `cargo +`ra_lsp_server` binary from `PATH`. For this it is important to have the following +in `setting.json` file: +```json +{ + "rust-analyzer.raLspServerPath": "ra_lsp_server" +} +``` +After I am done with the fix, I use `cargo xtask install --client-code` to try the new extension for real. If I need to fix something in the `ra_lsp_server` crate, I feel sad because it's diff --git a/docs/user/README.md b/docs/user/README.md index 3da30a193..1e7d516c5 100644 --- a/docs/user/README.md +++ b/docs/user/README.md @@ -57,7 +57,7 @@ For updates you need to remove installed binary rm -rf ${HOME}/.config/Code/User/globalStorage/matklad.rust-analyzer ``` -`"Donwload latest language server"` command for VSCode and automatic updates detection is currently WIP. +`"Download latest language server"` command for VSCode and automatic updates detection is currently WIP. ### Installation from sources @@ -71,6 +71,16 @@ $ cd rust-analyzer $ cargo xtask install ``` +After that you need to amend your `settings.json` file to explicitly specify the +path to `ra_lsp_server` that you've just built. +```json +{ + "rust-analyzer.raLspServerPath": "ra_lsp_server" +} +``` +This should work on all platforms, otherwise if installed `ra_lsp_server` is not available through your `$PATH` then see how to configure it [here](#setting-up-the-PATH-variable). + + The automatic installation is expected to *just work* for common cases, if it doesn't, report bugs! @@ -127,7 +137,7 @@ host. As an example, [Pale Fire](https://github.com/matklad/pale-fire/) color scheme tweaks rust colors. * `rust-analyzer.enableEnhancedTyping`: by default, rust-analyzer intercepts the `Enter` key to make it easier to continue comments. Note that it may conflict with VIM emulation plugin. -* `rust-analyzer.raLspServerPath`: path to `ra_lsp_server` executable +* `rust-analyzer.raLspServerPath`: path to `ra_lsp_server` executable, when absent or `null` defaults to prebuilt binary path * `rust-analyzer.enableCargoWatchOnStartup`: prompt to install & enable `cargo watch` for live error highlighting (note, this **does not** use rust-analyzer) * `rust-analyzer.excludeGlobs`: a list of glob-patterns for exclusion (see globset [docs](https://docs.rs/globset) for syntax). @@ -232,7 +242,8 @@ Installation: * You can now invoke the command palette and type LSP enable to locally/globally enable the rust-analyzer LSP (type LSP enable, then choose either locally or globally, then select rust-analyzer) -### Setting up the `PATH` variable + +### Setting up the `PATH` variable On Unix systems, `rustup` adds `~/.cargo/bin` to `PATH` by modifying the shell's startup file. Depending on your configuration, your Desktop Environment might not -- cgit v1.2.3