docs/user/generated_config.adoc

   1 [[rust-analyzer.assist.importMergeBehavior]]rust-analyzer.assist.importMergeBehavior (default: `"full"`)::
   2 +
   3 --
   4 The strategy to use when inserting new imports or merging imports.
   5 --
   6 [[rust-analyzer.assist.importPrefix]]rust-analyzer.assist.importPrefix (default: `"plain"`)::
   7 +
   8 --
   9 The path structure for newly inserted paths to use.
  10 --
  11 [[rust-analyzer.assist.importGroup]]rust-analyzer.assist.importGroup (default: `true`)::
  12 +
  13 --
  14 Group inserted imports by the [following order](https://rust-analyzer.github.io/manual.html#auto-import). Groups are separated by newlines.
  15 --
  16 [[rust-analyzer.callInfo.full]]rust-analyzer.callInfo.full (default: `true`)::
  17 +
  18 --
  19 Show function name and docs in parameter hints.
  20 --
  21 [[rust-analyzer.cargo.autoreload]]rust-analyzer.cargo.autoreload (default: `true`)::
  22 +
  23 --
  24 Automatically refresh project info via `cargo metadata` on
  25 `Cargo.toml` changes.
  26 --
  27 [[rust-analyzer.cargo.allFeatures]]rust-analyzer.cargo.allFeatures (default: `false`)::
  28 +
  29 --
  30 Activate all available features (`--all-features`).
  31 --
  32 [[rust-analyzer.cargo.features]]rust-analyzer.cargo.features (default: `[]`)::
  33 +
  34 --
  35 List of features to activate.
  36 --
  37 [[rust-analyzer.cargo.runBuildScripts]]rust-analyzer.cargo.runBuildScripts (default: `true`)::
  38 +
  39 --
  40 Run build scripts (`build.rs`) for more precise code analysis.
  41 --
  42 [[rust-analyzer.cargo.noDefaultFeatures]]rust-analyzer.cargo.noDefaultFeatures (default: `false`)::
  43 +
  44 --
  45 Do not activate the `default` feature.
  46 --
  47 [[rust-analyzer.cargo.target]]rust-analyzer.cargo.target (default: `null`)::
  48 +
  49 --
  50 Compilation target (target triple).
  51 --
  52 [[rust-analyzer.cargo.noSysroot]]rust-analyzer.cargo.noSysroot (default: `false`)::
  53 +
  54 --
  55 Internal config for debugging, disables loading of sysroot crates.
  56 --
  57 [[rust-analyzer.checkOnSave.enable]]rust-analyzer.checkOnSave.enable (default: `true`)::
  58 +
  59 --
  60 Run specified `cargo check` command for diagnostics on save.
  61 --
  62 [[rust-analyzer.checkOnSave.allFeatures]]rust-analyzer.checkOnSave.allFeatures (default: `null`)::
  63 +
  64 --
  65 Check with all features (`--all-features`).
  66 Defaults to `#rust-analyzer.cargo.allFeatures#`.
  67 --
  68 [[rust-analyzer.checkOnSave.allTargets]]rust-analyzer.checkOnSave.allTargets (default: `true`)::
  69 +
  70 --
  71 Check all targets and tests (`--all-targets`).
  72 --
  73 [[rust-analyzer.checkOnSave.command]]rust-analyzer.checkOnSave.command (default: `"check"`)::
  74 +
  75 --
  76 Cargo command to use for `cargo check`.
  77 --
  78 [[rust-analyzer.checkOnSave.noDefaultFeatures]]rust-analyzer.checkOnSave.noDefaultFeatures (default: `null`)::
  79 +
  80 --
  81 Do not activate the `default` feature.
  82 --
  83 [[rust-analyzer.checkOnSave.target]]rust-analyzer.checkOnSave.target (default: `null`)::
  84 +
  85 --
  86 Check for a specific target. Defaults to
  87 `#rust-analyzer.cargo.target#`.
  88 --
  89 [[rust-analyzer.checkOnSave.extraArgs]]rust-analyzer.checkOnSave.extraArgs (default: `[]`)::
  90 +
  91 --
  92 Extra arguments for `cargo check`.
  93 --
  94 [[rust-analyzer.checkOnSave.features]]rust-analyzer.checkOnSave.features (default: `null`)::
  95 +
  96 --
  97 List of features to activate. Defaults to
  98 `#rust-analyzer.cargo.features#`.
  99 --
 100 [[rust-analyzer.checkOnSave.overrideCommand]]rust-analyzer.checkOnSave.overrideCommand (default: `null`)::
 101 +
 102 --
 103 Advanced option, fully override the command rust-analyzer uses for
 104 checking. The command should include `--message-format=json` or
 105 similar option.
 106 --
 107 [[rust-analyzer.completion.addCallArgumentSnippets]]rust-analyzer.completion.addCallArgumentSnippets (default: `true`)::
 108 +
 109 --
 110 Whether to add argument snippets when completing functions.
 111 --
 112 [[rust-analyzer.completion.addCallParenthesis]]rust-analyzer.completion.addCallParenthesis (default: `true`)::
 113 +
 114 --
 115 Whether to add parenthesis when completing functions.
 116 --
 117 [[rust-analyzer.completion.postfix.enable]]rust-analyzer.completion.postfix.enable (default: `true`)::
 118 +
 119 --
 120 Whether to show postfix snippets like `dbg`, `if`, `not`, etc.
 121 --
 122 [[rust-analyzer.completion.autoimport.enable]]rust-analyzer.completion.autoimport.enable (default: `true`)::
 123 +
 124 --
 125 Toggles the additional completions that automatically add imports when completed.
 126 Note that your client must specify the `additionalTextEdits` LSP client capability to truly have this feature enabled.
 127 --
 128 [[rust-analyzer.diagnostics.enable]]rust-analyzer.diagnostics.enable (default: `true`)::
 129 +
 130 --
 131 Whether to show native rust-analyzer diagnostics.
 132 --
 133 [[rust-analyzer.diagnostics.enableExperimental]]rust-analyzer.diagnostics.enableExperimental (default: `true`)::
 134 +
 135 --
 136 Whether to show experimental rust-analyzer diagnostics that might
 137 have more false positives than usual.
 138 --
 139 [[rust-analyzer.diagnostics.disabled]]rust-analyzer.diagnostics.disabled (default: `[]`)::
 140 +
 141 --
 142 List of rust-analyzer diagnostics to disable.
 143 --
 144 [[rust-analyzer.diagnostics.warningsAsHint]]rust-analyzer.diagnostics.warningsAsHint (default: `[]`)::
 145 +
 146 --
 147 List of warnings that should be displayed with info severity.
 148
 149 The warnings will be indicated by a blue squiggly underline in code
 150 and a blue icon in the `Problems Panel`.
 151 --
 152 [[rust-analyzer.diagnostics.warningsAsInfo]]rust-analyzer.diagnostics.warningsAsInfo (default: `[]`)::
 153 +
 154 --
 155 List of warnings that should be displayed with hint severity.
 156
 157 The warnings will be indicated by faded text or three dots in code
 158 and will not show up in the `Problems Panel`.
 159 --
 160 [[rust-analyzer.files.watcher]]rust-analyzer.files.watcher (default: `"client"`)::
 161 +
 162 --
 163 Controls file watching implementation.
 164 --
 165 [[rust-analyzer.files.excludeDirs]]rust-analyzer.files.excludeDirs (default: `[]`)::
 166 +
 167 --
 168 These directories will be ignored by rust-analyzer.
 169 --
 170 [[rust-analyzer.hoverActions.debug]]rust-analyzer.hoverActions.debug (default: `true`)::
 171 +
 172 --
 173 Whether to show `Debug` action. Only applies when
 174 `#rust-analyzer.hoverActions.enable#` is set.
 175 --
 176 [[rust-analyzer.hoverActions.enable]]rust-analyzer.hoverActions.enable (default: `true`)::
 177 +
 178 --
 179 Whether to show HoverActions in Rust files.
 180 --
 181 [[rust-analyzer.hoverActions.gotoTypeDef]]rust-analyzer.hoverActions.gotoTypeDef (default: `true`)::
 182 +
 183 --
 184 Whether to show `Go to Type Definition` action. Only applies when
 185 `#rust-analyzer.hoverActions.enable#` is set.
 186 --
 187 [[rust-analyzer.hoverActions.implementations]]rust-analyzer.hoverActions.implementations (default: `true`)::
 188 +
 189 --
 190 Whether to show `Implementations` action. Only applies when
 191 `#rust-analyzer.hoverActions.enable#` is set.
 192 --
 193 [[rust-analyzer.hoverActions.run]]rust-analyzer.hoverActions.run (default: `true`)::
 194 +
 195 --
 196 Whether to show `Run` action. Only applies when
 197 `#rust-analyzer.hoverActions.enable#` is set.
 198 --
 199 [[rust-analyzer.hoverActions.linksInHover]]rust-analyzer.hoverActions.linksInHover (default: `true`)::
 200 +
 201 --
 202 Use markdown syntax for links in hover.
 203 --
 204 [[rust-analyzer.inlayHints.chainingHints]]rust-analyzer.inlayHints.chainingHints (default: `true`)::
 205 +
 206 --
 207 Whether to show inlay type hints for method chains.
 208 --
 209 [[rust-analyzer.inlayHints.maxLength]]rust-analyzer.inlayHints.maxLength (default: `null`)::
 210 +
 211 --
 212 Maximum length for inlay hints. Default is unlimited.
 213 --
 214 [[rust-analyzer.inlayHints.parameterHints]]rust-analyzer.inlayHints.parameterHints (default: `true`)::
 215 +
 216 --
 217 Whether to show function parameter name inlay hints at the call
 218 site.
 219 --
 220 [[rust-analyzer.inlayHints.typeHints]]rust-analyzer.inlayHints.typeHints (default: `true`)::
 221 +
 222 --
 223 Whether to show inlay type hints for variables.
 224 --
 225 [[rust-analyzer.lens.debug]]rust-analyzer.lens.debug (default: `true`)::
 226 +
 227 --
 228 Whether to show `Debug` lens. Only applies when
 229 `#rust-analyzer.lens.enable#` is set.
 230 --
 231 [[rust-analyzer.lens.enable]]rust-analyzer.lens.enable (default: `true`)::
 232 +
 233 --
 234 Whether to show CodeLens in Rust files.
 235 --
 236 [[rust-analyzer.lens.implementations]]rust-analyzer.lens.implementations (default: `true`)::
 237 +
 238 --
 239 Whether to show `Implementations` lens. Only applies when
 240 `#rust-analyzer.lens.enable#` is set.
 241 --
 242 [[rust-analyzer.lens.run]]rust-analyzer.lens.run (default: `true`)::
 243 +
 244 --
 245 Whether to show `Run` lens. Only applies when
 246 `#rust-analyzer.lens.enable#` is set.
 247 --
 248 [[rust-analyzer.lens.methodReferences]]rust-analyzer.lens.methodReferences (default: `false`)::
 249 +
 250 --
 251 Whether to show `Method References` lens. Only applies when
 252 `#rust-analyzer.lens.enable#` is set.
 253 --
 254 [[rust-analyzer.lens.references]]rust-analyzer.lens.references (default: `false`)::
 255 +
 256 --
 257 Whether to show `References` lens. Only applies when
 258 `#rust-analyzer.lens.enable#` is set.
 259 --
 260 [[rust-analyzer.linkedProjects]]rust-analyzer.linkedProjects (default: `[]`)::
 261 +
 262 --
 263 Disable project auto-discovery in favor of explicitly specified set
 264 of projects.
 265
 266 Elements must be paths pointing to `Cargo.toml`,
 267 `rust-project.json`, or JSON objects in `rust-project.json` format.
 268 --
 269 [[rust-analyzer.lruCapacity]]rust-analyzer.lruCapacity (default: `null`)::
 270 +
 271 --
 272 Number of syntax trees rust-analyzer keeps in memory. Defaults to 128.
 273 --
 274 [[rust-analyzer.notifications.cargoTomlNotFound]]rust-analyzer.notifications.cargoTomlNotFound (default: `true`)::
 275 +
 276 --
 277 Whether to show `can't find Cargo.toml` error message.
 278 --
 279 [[rust-analyzer.procMacro.enable]]rust-analyzer.procMacro.enable (default: `false`)::
 280 +
 281 --
 282 Enable support for procedural macros, implies `#rust-analyzer.cargo.runBuildScripts#`.
 283 --
 284 [[rust-analyzer.procMacro.server]]rust-analyzer.procMacro.server (default: `null`)::
 285 +
 286 --
 287 Internal config, path to proc-macro server executable (typically,
 288 this is rust-analyzer itself, but we override this in tests).
 289 --
 290 [[rust-analyzer.runnables.overrideCargo]]rust-analyzer.runnables.overrideCargo (default: `null`)::
 291 +
 292 --
 293 Command to be executed instead of 'cargo' for runnables.
 294 --
 295 [[rust-analyzer.runnables.cargoExtraArgs]]rust-analyzer.runnables.cargoExtraArgs (default: `[]`)::
 296 +
 297 --
 298 Additional arguments to be passed to cargo for runnables such as
 299 tests or binaries. For example, it may be `--release`.
 300 --
 301 [[rust-analyzer.rustcSource]]rust-analyzer.rustcSource (default: `null`)::
 302 +
 303 --
 304 Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private
 305 projects, or "discover" to try to automatically find it.
 306
 307 Any project which uses rust-analyzer with the rustcPrivate
 308 crates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it.
 309
 310 This option is not reloaded automatically; you must restart rust-analyzer for it to take effect.
 311 --
 312 [[rust-analyzer.rustfmt.extraArgs]]rust-analyzer.rustfmt.extraArgs (default: `[]`)::
 313 +
 314 --
 315 Additional arguments to `rustfmt`.
 316 --
 317 [[rust-analyzer.rustfmt.overrideCommand]]rust-analyzer.rustfmt.overrideCommand (default: `null`)::
 318 +
 319 --
 320 Advanced option, fully override the command rust-analyzer uses for
 321 formatting.
 322 --