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