From 6781692732d04968fe8ce09ded59f2faae492d82 Mon Sep 17 00:00:00 2001 From: Ilya Bobyr Date: Wed, 3 Feb 2021 18:33:19 -0800 Subject: Explain how initial configuration is sent over LSP. --- docs/user/manual.adoc | 32 +++++++++++++++++++++++++++----- 1 file changed, 27 insertions(+), 5 deletions(-) (limited to 'docs/user') diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc index 10d4fd606..93bf6d678 100644 --- a/docs/user/manual.adoc +++ b/docs/user/manual.adoc @@ -335,13 +335,35 @@ If the LSP binary is not available, GNOME Builder can install it when opening a **Source:** https://github.com/rust-analyzer/rust-analyzer/blob/master/crates/rust-analyzer/src/config.rs[config.rs] -rust-analyzer is configured via LSP messages, which means that it's up to the editor to decide on the exact format and location of configuration files. -Please consult your editor's documentation to learn how to configure LSP servers. +The <<_installation,Installation>> section contains details on configuration for some of the editors. +In general `rust-analyzer` is configured via LSP messages, which means that it's up to the editor to decide on the exact format and location of configuration files. -To verify which configuration is actually used by rust-analyzer, set `RA_LOG` environment variable to `rust_analyzer=info` and look for config-related messages. -Logs should show both the JSON that rust-analyzer sees as well as the updated config. +Some clients, such as <> or <> provide `rust-analyzer` specific configuration UIs. Others may require you to know a bit more about the interaction with `rust-analyzer`. -This is the list of config options rust-analyzer supports: +For the later category, it might help to know that the initial configuration is specified as a value of the `intializationOptions` field of the https://microsoft.github.io/language-server-protocol/specifications/specification-current/#initialize[`InitializeParams` message, in the LSP protocol]. +The spec says that the field type is `any?`, but `rust-analyzer` is looking for a JSON object that is constructed using settings from the list below. +Name of the setting, ignoring the `rust-analyzer.` prefix, is used as a path, and value of the setting becomes the JSON property value. + +For example, a very common configuration is to enable proc-macro support, can be achieved by sending this JSON: + +[source,json] +---- +{ + "cargo": { + "loadOutDirsFromCheck": true, + }, + "procMacro": { + "enable": true, + } +} +---- + +Please consult your editor's documentation to learn more about how to configure https://microsoft.github.io/language-server-protocol/[LSP servers]. + +To verify which configuration is actually used by `rust-analyzer`, set `RA_LOG` environment variable to `rust_analyzer=info` and look for config-related messages. +Logs should show both the JSON that `rust-analyzer` sees as well as the updated config. + +This is the list of config options `rust-analyzer` supports: include::./generated_config.adoc[] -- cgit v1.2.3