docs/user/generated_config.adoc

   1 [[rust-analyzer.assist.importGranularity]]rust-analyzer.assist.importGranularity (default: `"crate"`)::
   2 +
   3 --
   4 How imports should be grouped into use statements.
   5 --
   6 [[rust-analyzer.assist.importEnforceGranularity]]rust-analyzer.assist.importEnforceGranularity (default: `false`)::
   7 +
   8 --
   9 Whether to enforce the import granularity setting for all files. If set to false rust-analyzer will try to keep import styles consistent per file.
  10 --
  11 [[rust-analyzer.assist.importPrefix]]rust-analyzer.assist.importPrefix (default: `"plain"`)::
  12 +
  13 --
  14 The path structure for newly inserted paths to use.
  15 --
  16 [[rust-analyzer.assist.importGroup]]rust-analyzer.assist.importGroup (default: `true`)::
  17 +
  18 --
  19 Group inserted imports by the [following order](https://rust-analyzer.github.io/manual.html#auto-import). Groups are separated by newlines.
  20 --
  21 [[rust-analyzer.assist.allowMergingIntoGlobImports]]rust-analyzer.assist.allowMergingIntoGlobImports (default: `true`)::
  22 +
  23 --
  24 Whether to allow import insertion to merge new imports into single path glob imports like `use std::fmt::*;`.
  25 --
  26 [[rust-analyzer.callInfo.full]]rust-analyzer.callInfo.full (default: `true`)::
  27 +
  28 --
  29 Show function name and docs in parameter hints.
  30 --
  31 [[rust-analyzer.cargo.autoreload]]rust-analyzer.cargo.autoreload (default: `true`)::
  32 +
  33 --
  34 Automatically refresh project info via `cargo metadata` on
  35 `Cargo.toml` changes.
  36 --
  37 [[rust-analyzer.cargo.allFeatures]]rust-analyzer.cargo.allFeatures (default: `false`)::
  38 +
  39 --
  40 Activate all available features (`--all-features`).
  41 --
  42 [[rust-analyzer.cargo.unsetTest]]rust-analyzer.cargo.unsetTest (default: `["core"]`)::
  43 +
  44 --
  45 Unsets `#[cfg(test)]` for the specified crates.
  46 --
  47 [[rust-analyzer.cargo.features]]rust-analyzer.cargo.features (default: `[]`)::
  48 +
  49 --
  50 List of features to activate.
  51 --
  52 [[rust-analyzer.cargo.runBuildScripts]]rust-analyzer.cargo.runBuildScripts (default: `true`)::
  53 +
  54 --
  55 Run build scripts (`build.rs`) for more precise code analysis.
  56 --
  57 [[rust-analyzer.cargo.useRustcWrapperForBuildScripts]]rust-analyzer.cargo.useRustcWrapperForBuildScripts (default: `true`)::
  58 +
  59 --
  60 Use `RUSTC_WRAPPER=rust-analyzer` when running build scripts to
  61 avoid compiling unnecessary things.
  62 --
  63 [[rust-analyzer.cargo.noDefaultFeatures]]rust-analyzer.cargo.noDefaultFeatures (default: `false`)::
  64 +
  65 --
  66 Do not activate the `default` feature.
  67 --
  68 [[rust-analyzer.cargo.target]]rust-analyzer.cargo.target (default: `null`)::
  69 +
  70 --
  71 Compilation target (target triple).
  72 --
  73 [[rust-analyzer.cargo.noSysroot]]rust-analyzer.cargo.noSysroot (default: `false`)::
  74 +
  75 --
  76 Internal config for debugging, disables loading of sysroot crates.
  77 --
  78 [[rust-analyzer.checkOnSave.enable]]rust-analyzer.checkOnSave.enable (default: `true`)::
  79 +
  80 --
  81 Run specified `cargo check` command for diagnostics on save.
  82 --
  83 [[rust-analyzer.checkOnSave.allFeatures]]rust-analyzer.checkOnSave.allFeatures (default: `null`)::
  84 +
  85 --
  86 Check with all features (`--all-features`).
  87 Defaults to `#rust-analyzer.cargo.allFeatures#`.
  88 --
  89 [[rust-analyzer.checkOnSave.allTargets]]rust-analyzer.checkOnSave.allTargets (default: `true`)::
  90 +
  91 --
  92 Check all targets and tests (`--all-targets`).
  93 --
  94 [[rust-analyzer.checkOnSave.command]]rust-analyzer.checkOnSave.command (default: `"check"`)::
  95 +
  96 --
  97 Cargo command to use for `cargo check`.
  98 --
  99 [[rust-analyzer.checkOnSave.noDefaultFeatures]]rust-analyzer.checkOnSave.noDefaultFeatures (default: `null`)::
 100 +
 101 --
 102 Do not activate the `default` feature.
 103 --
 104 [[rust-analyzer.checkOnSave.target]]rust-analyzer.checkOnSave.target (default: `null`)::
 105 +
 106 --
 107 Check for a specific target. Defaults to
 108 `#rust-analyzer.cargo.target#`.
 109 --
 110 [[rust-analyzer.checkOnSave.extraArgs]]rust-analyzer.checkOnSave.extraArgs (default: `[]`)::
 111 +
 112 --
 113 Extra arguments for `cargo check`.
 114 --
 115 [[rust-analyzer.checkOnSave.features]]rust-analyzer.checkOnSave.features (default: `null`)::
 116 +
 117 --
 118 List of features to activate. Defaults to
 119 `#rust-analyzer.cargo.features#`.
 120 --
 121 [[rust-analyzer.checkOnSave.overrideCommand]]rust-analyzer.checkOnSave.overrideCommand (default: `null`)::
 122 +
 123 --
 124 Advanced option, fully override the command rust-analyzer uses for
 125 checking. The command should include `--message-format=json` or
 126 similar option.
 127 --
 128 [[rust-analyzer.completion.addCallArgumentSnippets]]rust-analyzer.completion.addCallArgumentSnippets (default: `true`)::
 129 +
 130 --
 131 Whether to add argument snippets when completing functions.
 132 Only applies when `#rust-analyzer.completion.addCallParenthesis#` is set.
 133 --
 134 [[rust-analyzer.completion.addCallParenthesis]]rust-analyzer.completion.addCallParenthesis (default: `true`)::
 135 +
 136 --
 137 Whether to add parenthesis when completing functions.
 138 --
 139 [[rust-analyzer.completion.postfix.enable]]rust-analyzer.completion.postfix.enable (default: `true`)::
 140 +
 141 --
 142 Whether to show postfix snippets like `dbg`, `if`, `not`, etc.
 143 --
 144 [[rust-analyzer.completion.autoimport.enable]]rust-analyzer.completion.autoimport.enable (default: `true`)::
 145 +
 146 --
 147 Toggles the additional completions that automatically add imports when completed.
 148 Note that your client must specify the `additionalTextEdits` LSP client capability to truly have this feature enabled.
 149 --
 150 [[rust-analyzer.completion.autoself.enable]]rust-analyzer.completion.autoself.enable (default: `true`)::
 151 +
 152 --
 153 Toggles the additional completions that automatically show method calls and field accesses
 154 with `self` prefixed to them when inside a method.
 155 --
 156 [[rust-analyzer.diagnostics.enable]]rust-analyzer.diagnostics.enable (default: `true`)::
 157 +
 158 --
 159 Whether to show native rust-analyzer diagnostics.
 160 --
 161 [[rust-analyzer.diagnostics.enableExperimental]]rust-analyzer.diagnostics.enableExperimental (default: `true`)::
 162 +
 163 --
 164 Whether to show experimental rust-analyzer diagnostics that might
 165 have more false positives than usual.
 166 --
 167 [[rust-analyzer.diagnostics.disabled]]rust-analyzer.diagnostics.disabled (default: `[]`)::
 168 +
 169 --
 170 List of rust-analyzer diagnostics to disable.
 171 --
 172 [[rust-analyzer.diagnostics.remapPrefix]]rust-analyzer.diagnostics.remapPrefix (default: `{}`)::
 173 +
 174 --
 175 Map of prefixes to be substituted when parsing diagnostic file paths.
 176 This should be the reverse mapping of what is passed to `rustc` as `--remap-path-prefix`.
 177 --
 178 [[rust-analyzer.diagnostics.warningsAsHint]]rust-analyzer.diagnostics.warningsAsHint (default: `[]`)::
 179 +
 180 --
 181 List of warnings that should be displayed with hint severity.
 182
 183 The warnings will be indicated by faded text or three dots in code
 184 and will not show up in the `Problems Panel`.
 185 --
 186 [[rust-analyzer.diagnostics.warningsAsInfo]]rust-analyzer.diagnostics.warningsAsInfo (default: `[]`)::
 187 +
 188 --
 189 List of warnings that should be displayed with info severity.
 190
 191 The warnings will be indicated by a blue squiggly underline in code
 192 and a blue icon in the `Problems Panel`.
 193 --
 194 [[rust-analyzer.experimental.procAttrMacros]]rust-analyzer.experimental.procAttrMacros (default: `false`)::
 195 +
 196 --
 197 Expand attribute macros.
 198 --
 199 [[rust-analyzer.files.watcher]]rust-analyzer.files.watcher (default: `"client"`)::
 200 +
 201 --
 202 Controls file watching implementation.
 203 --
 204 [[rust-analyzer.files.excludeDirs]]rust-analyzer.files.excludeDirs (default: `[]`)::
 205 +
 206 --
 207 These directories will be ignored by rust-analyzer. They are
 208 relative to the workspace root, and globs are not supported. You may
 209 also need to add the folders to Code's `files.watcherExclude`.
 210 --
 211 [[rust-analyzer.highlighting.strings]]rust-analyzer.highlighting.strings (default: `true`)::
 212 +
 213 --
 214 Use semantic tokens for strings.
 215
 216 In some editors (e.g. vscode) semantic tokens override other highlighting grammars.
 217 By disabling semantic tokens for strings, other grammars can be used to highlight
 218 their contents.
 219 --
 220 [[rust-analyzer.hover.documentation]]rust-analyzer.hover.documentation (default: `true`)::
 221 +
 222 --
 223 Whether to show documentation on hover.
 224 --
 225 [[rust-analyzer.hover.linksInHover]]rust-analyzer.hover.linksInHover (default: `true`)::
 226 +
 227 --
 228 Use markdown syntax for links in hover.
 229 --
 230 [[rust-analyzer.hoverActions.debug]]rust-analyzer.hoverActions.debug (default: `true`)::
 231 +
 232 --
 233 Whether to show `Debug` action. Only applies when
 234 `#rust-analyzer.hoverActions.enable#` is set.
 235 --
 236 [[rust-analyzer.hoverActions.enable]]rust-analyzer.hoverActions.enable (default: `true`)::
 237 +
 238 --
 239 Whether to show HoverActions in Rust files.
 240 --
 241 [[rust-analyzer.hoverActions.gotoTypeDef]]rust-analyzer.hoverActions.gotoTypeDef (default: `true`)::
 242 +
 243 --
 244 Whether to show `Go to Type Definition` action. Only applies when
 245 `#rust-analyzer.hoverActions.enable#` is set.
 246 --
 247 [[rust-analyzer.hoverActions.implementations]]rust-analyzer.hoverActions.implementations (default: `true`)::
 248 +
 249 --
 250 Whether to show `Implementations` action. Only applies when
 251 `#rust-analyzer.hoverActions.enable#` is set.
 252 --
 253 [[rust-analyzer.hoverActions.references]]rust-analyzer.hoverActions.references (default: `false`)::
 254 +
 255 --
 256 Whether to show `References` action. Only applies when
 257 `#rust-analyzer.hoverActions.enable#` is set.
 258 --
 259 [[rust-analyzer.hoverActions.run]]rust-analyzer.hoverActions.run (default: `true`)::
 260 +
 261 --
 262 Whether to show `Run` action. Only applies when
 263 `#rust-analyzer.hoverActions.enable#` is set.
 264 --
 265 [[rust-analyzer.inlayHints.chainingHints]]rust-analyzer.inlayHints.chainingHints (default: `true`)::
 266 +
 267 --
 268 Whether to show inlay type hints for method chains.
 269 --
 270 [[rust-analyzer.inlayHints.maxLength]]rust-analyzer.inlayHints.maxLength (default: `25`)::
 271 +
 272 --
 273 Maximum length for inlay hints. Set to null to have an unlimited length.
 274 --
 275 [[rust-analyzer.inlayHints.parameterHints]]rust-analyzer.inlayHints.parameterHints (default: `true`)::
 276 +
 277 --
 278 Whether to show function parameter name inlay hints at the call
 279 site.
 280 --
 281 [[rust-analyzer.inlayHints.typeHints]]rust-analyzer.inlayHints.typeHints (default: `true`)::
 282 +
 283 --
 284 Whether to show inlay type hints for variables.
 285 --
 286 [[rust-analyzer.joinLines.joinElseIf]]rust-analyzer.joinLines.joinElseIf (default: `true`)::
 287 +
 288 --
 289 Join lines inserts else between consecutive ifs.
 290 --
 291 [[rust-analyzer.joinLines.removeTrailingComma]]rust-analyzer.joinLines.removeTrailingComma (default: `true`)::
 292 +
 293 --
 294 Join lines removes trailing commas.
 295 --
 296 [[rust-analyzer.joinLines.unwrapTrivialBlock]]rust-analyzer.joinLines.unwrapTrivialBlock (default: `true`)::
 297 +
 298 --
 299 Join lines unwraps trivial blocks.
 300 --
 301 [[rust-analyzer.lens.debug]]rust-analyzer.lens.debug (default: `true`)::
 302 +
 303 --
 304 Whether to show `Debug` lens. Only applies when
 305 `#rust-analyzer.lens.enable#` is set.
 306 --
 307 [[rust-analyzer.lens.enable]]rust-analyzer.lens.enable (default: `true`)::
 308 +
 309 --
 310 Whether to show CodeLens in Rust files.
 311 --
 312 [[rust-analyzer.lens.implementations]]rust-analyzer.lens.implementations (default: `true`)::
 313 +
 314 --
 315 Whether to show `Implementations` lens. Only applies when
 316 `#rust-analyzer.lens.enable#` is set.
 317 --
 318 [[rust-analyzer.lens.run]]rust-analyzer.lens.run (default: `true`)::
 319 +
 320 --
 321 Whether to show `Run` lens. Only applies when
 322 `#rust-analyzer.lens.enable#` is set.
 323 --
 324 [[rust-analyzer.lens.methodReferences]]rust-analyzer.lens.methodReferences (default: `false`)::
 325 +
 326 --
 327 Whether to show `Method References` lens. Only applies when
 328 `#rust-analyzer.lens.enable#` is set.
 329 --
 330 [[rust-analyzer.lens.references]]rust-analyzer.lens.references (default: `false`)::
 331 +
 332 --
 333 Whether to show `References` lens. Only applies when
 334 `#rust-analyzer.lens.enable#` is set.
 335 --
 336 [[rust-analyzer.linkedProjects]]rust-analyzer.linkedProjects (default: `[]`)::
 337 +
 338 --
 339 Disable project auto-discovery in favor of explicitly specified set
 340 of projects.
 341
 342 Elements must be paths pointing to `Cargo.toml`,
 343 `rust-project.json`, or JSON objects in `rust-project.json` format.
 344 --
 345 [[rust-analyzer.lruCapacity]]rust-analyzer.lruCapacity (default: `null`)::
 346 +
 347 --
 348 Number of syntax trees rust-analyzer keeps in memory. Defaults to 128.
 349 --
 350 [[rust-analyzer.notifications.cargoTomlNotFound]]rust-analyzer.notifications.cargoTomlNotFound (default: `true`)::
 351 +
 352 --
 353 Whether to show `can't find Cargo.toml` error message.
 354 --
 355 [[rust-analyzer.procMacro.enable]]rust-analyzer.procMacro.enable (default: `true`)::
 356 +
 357 --
 358 Enable support for procedural macros, implies `#rust-analyzer.cargo.runBuildScripts#`.
 359 --
 360 [[rust-analyzer.procMacro.server]]rust-analyzer.procMacro.server (default: `null`)::
 361 +
 362 --
 363 Internal config, path to proc-macro server executable (typically,
 364 this is rust-analyzer itself, but we override this in tests).
 365 --
 366 [[rust-analyzer.runnables.overrideCargo]]rust-analyzer.runnables.overrideCargo (default: `null`)::
 367 +
 368 --
 369 Command to be executed instead of 'cargo' for runnables.
 370 --
 371 [[rust-analyzer.runnables.cargoExtraArgs]]rust-analyzer.runnables.cargoExtraArgs (default: `[]`)::
 372 +
 373 --
 374 Additional arguments to be passed to cargo for runnables such as
 375 tests or binaries. For example, it may be `--release`.
 376 --
 377 [[rust-analyzer.rustcSource]]rust-analyzer.rustcSource (default: `null`)::
 378 +
 379 --
 380 Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private
 381 projects, or "discover" to try to automatically find it.
 382
 383 Any project which uses rust-analyzer with the rustcPrivate
 384 crates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it.
 385
 386 This option is not reloaded automatically; you must restart rust-analyzer for it to take effect.
 387 --
 388 [[rust-analyzer.rustfmt.extraArgs]]rust-analyzer.rustfmt.extraArgs (default: `[]`)::
 389 +
 390 --
 391 Additional arguments to `rustfmt`.
 392 --
 393 [[rust-analyzer.rustfmt.overrideCommand]]rust-analyzer.rustfmt.overrideCommand (default: `null`)::
 394 +
 395 --
 396 Advanced option, fully override the command rust-analyzer uses for
 397 formatting.
 398 --
 399 [[rust-analyzer.rustfmt.enableRangeFormatting]]rust-analyzer.rustfmt.enableRangeFormatting (default: `false`)::
 400 +
 401 --
 402 Enables the use of rustfmt's unstable range formatting command for the
 403 `textDocument/rangeFormatting` request. The rustfmt option is unstable and only
 404 available on a nightly build.
 405 --
 406 [[rust-analyzer.workspace.symbol.search.scope]]rust-analyzer.workspace.symbol.search.scope (default: `"workspace"`)::
 407 +
 408 --
 409 Workspace symbol search scope.
 410 --
 411 [[rust-analyzer.workspace.symbol.search.kind]]rust-analyzer.workspace.symbol.search.kind (default: `"only_types"`)::
 412 +
 413 --
 414 Workspace symbol search kind.
 415 --