X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=docs%2Fuser%2Fgenerated_config.adoc;h=5e7b7222262b10db6a1496bf56e01956fa10895e;hb=eb17e90eba1113702349af93c0ff51269123b922;hp=58cb469740fe4415ea954fd52b1eaadc05464fe7;hpb=8b77e2692cd97552b1b8d66eb51cec69695b3a5b;p=rust.git diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc index 58cb469740f..5e7b7222262 100644 --- a/docs/user/generated_config.adoc +++ b/docs/user/generated_config.adoc @@ -16,7 +16,7 @@ The path structure for newly inserted paths to use. [[rust-analyzer.assist.importGroup]]rust-analyzer.assist.importGroup (default: `true`):: + -- -Group inserted imports by the [following order](https://rust-analyzer.github.io/manual.html#auto-import). Groups are separated by newlines. +Group inserted imports by the https://rust-analyzer.github.io/manual.html#auto-import[following order]. Groups are separated by newlines. -- [[rust-analyzer.assist.allowMergingIntoGlobImports]]rust-analyzer.assist.allowMergingIntoGlobImports (default: `true`):: + @@ -204,7 +204,29 @@ Controls file watching implementation. [[rust-analyzer.files.excludeDirs]]rust-analyzer.files.excludeDirs (default: `[]`):: + -- -These directories will be ignored by rust-analyzer. +These directories will be ignored by rust-analyzer. They are +relative to the workspace root, and globs are not supported. You may +also need to add the folders to Code's `files.watcherExclude`. +-- +[[rust-analyzer.highlightRelated.references]]rust-analyzer.highlightRelated.references (default: `true`):: ++ +-- +Enables highlighting of related references while hovering your mouse above any identifier. +-- +[[rust-analyzer.highlightRelated.exitPoints]]rust-analyzer.highlightRelated.exitPoints (default: `true`):: ++ +-- +Enables highlighting of all exit points while hovering your mouse above any `return`, `?`, or return type arrow (`->`). +-- +[[rust-analyzer.highlightRelated.breakPoints]]rust-analyzer.highlightRelated.breakPoints (default: `true`):: ++ +-- +Enables highlighting of related references while hovering your mouse `break`, `loop`, `while`, or `for` keywords. +-- +[[rust-analyzer.highlightRelated.yieldPoints]]rust-analyzer.highlightRelated.yieldPoints (default: `true`):: ++ +-- +Enables highlighting of all break points for a loop or block context while hovering your mouse above any `async` or `await` keywords. -- [[rust-analyzer.highlighting.strings]]rust-analyzer.highlighting.strings (default: `true`):: + @@ -215,6 +237,16 @@ In some editors (e.g. vscode) semantic tokens override other highlighting gramma By disabling semantic tokens for strings, other grammars can be used to highlight their contents. -- +[[rust-analyzer.hover.documentation]]rust-analyzer.hover.documentation (default: `true`):: ++ +-- +Whether to show documentation on hover. +-- +[[rust-analyzer.hover.linksInHover]]rust-analyzer.hover.linksInHover (default: `true`):: ++ +-- +Use markdown syntax for links in hover. +-- [[rust-analyzer.hoverActions.debug]]rust-analyzer.hoverActions.debug (default: `true`):: + -- @@ -250,11 +282,6 @@ Whether to show `References` action. Only applies when Whether to show `Run` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set. -- -[[rust-analyzer.hoverActions.linksInHover]]rust-analyzer.hoverActions.linksInHover (default: `true`):: -+ --- -Use markdown syntax for links in hover. --- [[rust-analyzer.inlayHints.chainingHints]]rust-analyzer.inlayHints.chainingHints (default: `true`):: + -- @@ -276,6 +303,26 @@ site. -- Whether to show inlay type hints for variables. -- +[[rust-analyzer.joinLines.joinElseIf]]rust-analyzer.joinLines.joinElseIf (default: `true`):: ++ +-- +Join lines inserts else between consecutive ifs. +-- +[[rust-analyzer.joinLines.removeTrailingComma]]rust-analyzer.joinLines.removeTrailingComma (default: `true`):: ++ +-- +Join lines removes trailing commas. +-- +[[rust-analyzer.joinLines.unwrapTrivialBlock]]rust-analyzer.joinLines.unwrapTrivialBlock (default: `true`):: ++ +-- +Join lines unwraps trivial blocks. +-- +[[rust-analyzer.joinLines.joinAssignments]]rust-analyzer.joinLines.joinAssignments (default: `true`):: ++ +-- +Join lines merges consecutive declaration and initialization of an assignment. +-- [[rust-analyzer.lens.debug]]rust-analyzer.lens.debug (default: `true`):: + -- @@ -311,6 +358,12 @@ Whether to show `Method References` lens. Only applies when Whether to show `References` lens. Only applies when `#rust-analyzer.lens.enable#` is set. -- +[[rust-analyzer.lens.forceCustomCommands]]rust-analyzer.lens.forceCustomCommands (default: `true`):: ++ +-- +Internal config: use custom client-side commands even when the +client doesn't set the corresponding capability. +-- [[rust-analyzer.linkedProjects]]rust-analyzer.linkedProjects (default: `[]`):: + --