docs/user/generated_config.adoc

   1 [[rust-analyzer.assist.importMergeBehavior]]rust-analyzer.assist.importMergeBehavior (default: `"full"`)::
   2  The strategy to use when inserting new imports or merging imports.
   3 [[rust-analyzer.assist.importPrefix]]rust-analyzer.assist.importPrefix (default: `"plain"`)::
   4  The path structure for newly inserted paths to use.
   5 [[rust-analyzer.assist.importGroup]]rust-analyzer.assist.importGroup (default: `true`)::
   6  Group inserted imports by the [following order](https://rust-analyzer.github.io/manual.html#auto-import). Groups are separated by newlines.
   7 [[rust-analyzer.callInfo.full]]rust-analyzer.callInfo.full (default: `true`)::
   8  Show function name and docs in parameter hints.
   9 [[rust-analyzer.cargo.autoreload]]rust-analyzer.cargo.autoreload (default: `true`)::
  10  Automatically refresh project info via `cargo metadata` on  `Cargo.toml` changes.
  11 [[rust-analyzer.cargo.allFeatures]]rust-analyzer.cargo.allFeatures (default: `false`)::
  12  Activate all available features (`--all-features`).
  13 [[rust-analyzer.cargo.features]]rust-analyzer.cargo.features (default: `[]`)::
  14  List of features to activate.
  15 [[rust-analyzer.cargo.runBuildScripts]]rust-analyzer.cargo.runBuildScripts (default: `true`)::
  16  Run build scripts (`build.rs`) for more precise code analysis.
  17 [[rust-analyzer.cargo.noDefaultFeatures]]rust-analyzer.cargo.noDefaultFeatures (default: `false`)::
  18  Do not activate the `default` feature.
  19 [[rust-analyzer.cargo.target]]rust-analyzer.cargo.target (default: `null`)::
  20  Compilation target (target triple).
  21 [[rust-analyzer.cargo.noSysroot]]rust-analyzer.cargo.noSysroot (default: `false`)::
  22  Internal config for debugging, disables loading of sysroot crates.
  23 [[rust-analyzer.checkOnSave.enable]]rust-analyzer.checkOnSave.enable (default: `true`)::
  24  Run specified `cargo check` command for diagnostics on save.
  25 [[rust-analyzer.checkOnSave.allFeatures]]rust-analyzer.checkOnSave.allFeatures (default: `null`)::
  26  Check with all features (`--all-features`).  Defaults to `#rust-analyzer.cargo.allFeatures#`.
  27 [[rust-analyzer.checkOnSave.allTargets]]rust-analyzer.checkOnSave.allTargets (default: `true`)::
  28  Check all targets and tests (`--all-targets`).
  29 [[rust-analyzer.checkOnSave.command]]rust-analyzer.checkOnSave.command (default: `"check"`)::
  30  Cargo command to use for `cargo check`.
  31 [[rust-analyzer.checkOnSave.noDefaultFeatures]]rust-analyzer.checkOnSave.noDefaultFeatures (default: `null`)::
  32  Do not activate the `default` feature.
  33 [[rust-analyzer.checkOnSave.target]]rust-analyzer.checkOnSave.target (default: `null`)::
  34  Check for a specific target. Defaults to  `#rust-analyzer.cargo.target#`.
  35 [[rust-analyzer.checkOnSave.extraArgs]]rust-analyzer.checkOnSave.extraArgs (default: `[]`)::
  36  Extra arguments for `cargo check`.
  37 [[rust-analyzer.checkOnSave.features]]rust-analyzer.checkOnSave.features (default: `null`)::
  38  List of features to activate. Defaults to  `#rust-analyzer.cargo.features#`.
  39 [[rust-analyzer.checkOnSave.overrideCommand]]rust-analyzer.checkOnSave.overrideCommand (default: `null`)::
  40  Advanced option, fully override the command rust-analyzer uses for  checking. The command should include `--message-format=json` or  similar option.
  41 [[rust-analyzer.completion.addCallArgumentSnippets]]rust-analyzer.completion.addCallArgumentSnippets (default: `true`)::
  42  Whether to add argument snippets when completing functions.
  43 [[rust-analyzer.completion.addCallParenthesis]]rust-analyzer.completion.addCallParenthesis (default: `true`)::
  44  Whether to add parenthesis when completing functions.
  45 [[rust-analyzer.completion.postfix.enable]]rust-analyzer.completion.postfix.enable (default: `true`)::
  46  Whether to show postfix snippets like `dbg`, `if`, `not`, etc.
  47 [[rust-analyzer.completion.autoimport.enable]]rust-analyzer.completion.autoimport.enable (default: `true`)::
  48  Toggles the additional completions that automatically add imports when completed.  Note that your client must specify the `additionalTextEdits` LSP client capability to truly have this feature enabled.
  49 [[rust-analyzer.diagnostics.enable]]rust-analyzer.diagnostics.enable (default: `true`)::
  50  Whether to show native rust-analyzer diagnostics.
  51 [[rust-analyzer.diagnostics.enableExperimental]]rust-analyzer.diagnostics.enableExperimental (default: `true`)::
  52  Whether to show experimental rust-analyzer diagnostics that might  have more false positives than usual.
  53 [[rust-analyzer.diagnostics.disabled]]rust-analyzer.diagnostics.disabled (default: `[]`)::
  54  List of rust-analyzer diagnostics to disable.
  55 [[rust-analyzer.diagnostics.warningsAsHint]]rust-analyzer.diagnostics.warningsAsHint (default: `[]`)::
  56  List of warnings that should be displayed with info severity.\n\nThe  warnings will be indicated by a blue squiggly underline in code and  a blue icon in the `Problems Panel`.
  57 [[rust-analyzer.diagnostics.warningsAsInfo]]rust-analyzer.diagnostics.warningsAsInfo (default: `[]`)::
  58  List of warnings that should be displayed with hint severity.\n\nThe  warnings will be indicated by faded text or three dots in code and  will not show up in the `Problems Panel`.
  59 [[rust-analyzer.files.watcher]]rust-analyzer.files.watcher (default: `"client"`)::
  60  Controls file watching implementation.
  61 [[rust-analyzer.files.excludeDirs]]rust-analyzer.files.excludeDirs (default: `[]`)::
  62  These directories will be ignored by rust-analyzer.
  63 [[rust-analyzer.hoverActions.debug]]rust-analyzer.hoverActions.debug (default: `true`)::
  64  Whether to show `Debug` action. Only applies when  `#rust-analyzer.hoverActions.enable#` is set.
  65 [[rust-analyzer.hoverActions.enable]]rust-analyzer.hoverActions.enable (default: `true`)::
  66  Whether to show HoverActions in Rust files.
  67 [[rust-analyzer.hoverActions.gotoTypeDef]]rust-analyzer.hoverActions.gotoTypeDef (default: `true`)::
  68  Whether to show `Go to Type Definition` action. Only applies when  `#rust-analyzer.hoverActions.enable#` is set.
  69 [[rust-analyzer.hoverActions.implementations]]rust-analyzer.hoverActions.implementations (default: `true`)::
  70  Whether to show `Implementations` action. Only applies when  `#rust-analyzer.hoverActions.enable#` is set.
  71 [[rust-analyzer.hoverActions.run]]rust-analyzer.hoverActions.run (default: `true`)::
  72  Whether to show `Run` action. Only applies when  `#rust-analyzer.hoverActions.enable#` is set.
  73 [[rust-analyzer.hoverActions.linksInHover]]rust-analyzer.hoverActions.linksInHover (default: `true`)::
  74  Use markdown syntax for links in hover.
  75 [[rust-analyzer.inlayHints.chainingHints]]rust-analyzer.inlayHints.chainingHints (default: `true`)::
  76  Whether to show inlay type hints for method chains.
  77 [[rust-analyzer.inlayHints.maxLength]]rust-analyzer.inlayHints.maxLength (default: `null`)::
  78  Maximum length for inlay hints. Default is unlimited.
  79 [[rust-analyzer.inlayHints.parameterHints]]rust-analyzer.inlayHints.parameterHints (default: `true`)::
  80  Whether to show function parameter name inlay hints at the call  site.
  81 [[rust-analyzer.inlayHints.typeHints]]rust-analyzer.inlayHints.typeHints (default: `true`)::
  82  Whether to show inlay type hints for variables.
  83 [[rust-analyzer.lens.debug]]rust-analyzer.lens.debug (default: `true`)::
  84  Whether to show `Debug` lens. Only applies when  `#rust-analyzer.lens.enable#` is set.
  85 [[rust-analyzer.lens.enable]]rust-analyzer.lens.enable (default: `true`)::
  86  Whether to show CodeLens in Rust files.
  87 [[rust-analyzer.lens.implementations]]rust-analyzer.lens.implementations (default: `true`)::
  88  Whether to show `Implementations` lens. Only applies when  `#rust-analyzer.lens.enable#` is set.
  89 [[rust-analyzer.lens.run]]rust-analyzer.lens.run (default: `true`)::
  90  Whether to show `Run` lens. Only applies when  `#rust-analyzer.lens.enable#` is set.
  91 [[rust-analyzer.lens.methodReferences]]rust-analyzer.lens.methodReferences (default: `false`)::
  92  Whether to show `Method References` lens. Only applies when  `#rust-analyzer.lens.enable#` is set.
  93 [[rust-analyzer.lens.references]]rust-analyzer.lens.references (default: `false`)::
  94  Whether to show `References` lens. Only applies when  `#rust-analyzer.lens.enable#` is set.
  95 [[rust-analyzer.linkedProjects]]rust-analyzer.linkedProjects (default: `[]`)::
  96  Disable project auto-discovery in favor of explicitly specified set  of projects.\n\nElements must be paths pointing to `Cargo.toml`,  `rust-project.json`, or JSON objects in `rust-project.json` format.
  97 [[rust-analyzer.lruCapacity]]rust-analyzer.lruCapacity (default: `null`)::
  98  Number of syntax trees rust-analyzer keeps in memory. Defaults to 128.
  99 [[rust-analyzer.notifications.cargoTomlNotFound]]rust-analyzer.notifications.cargoTomlNotFound (default: `true`)::
 100  Whether to show `can't find Cargo.toml` error message.
 101 [[rust-analyzer.procMacro.enable]]rust-analyzer.procMacro.enable (default: `false`)::
 102  Enable support for procedural macros, implies `#rust-analyzer.cargo.runBuildScripts#`.
 103 [[rust-analyzer.procMacro.server]]rust-analyzer.procMacro.server (default: `null`)::
 104  Internal config, path to proc-macro server executable (typically,  this is rust-analyzer itself, but we override this in tests).
 105 [[rust-analyzer.runnables.overrideCargo]]rust-analyzer.runnables.overrideCargo (default: `null`)::
 106  Command to be executed instead of 'cargo' for runnables.
 107 [[rust-analyzer.runnables.cargoExtraArgs]]rust-analyzer.runnables.cargoExtraArgs (default: `[]`)::
 108  Additional arguments to be passed to cargo for runnables such as  tests or binaries.\nFor example, it may be `--release`.
 109 [[rust-analyzer.rustcSource]]rust-analyzer.rustcSource (default: `null`)::
 110  Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private  projects, or "discover" to try to automatically find it.   Any project which uses rust-analyzer with the rustcPrivate  crates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it.   This option is not reloaded automatically; you must restart rust-analyzer for it to take effect.
 111 [[rust-analyzer.rustfmt.extraArgs]]rust-analyzer.rustfmt.extraArgs (default: `[]`)::
 112  Additional arguments to `rustfmt`.
 113 [[rust-analyzer.rustfmt.overrideCommand]]rust-analyzer.rustfmt.overrideCommand (default: `null`)::
 114  Advanced option, fully override the command rust-analyzer uses for  formatting.