Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-12-28 14:03:35 +00:00
Code Issues Projects Releases Packages Wiki Activity
rust-analyzer/docs/user/generated_config.adoc

111 lines
9.3 KiB
Text
Raw Normal View History

Use american spelling for config As per https://github.com/rust-analyzer/rust-analyzer/blob/171c3c08fe245938fb25321394233de5fe2abc7c/docs/dev/style.md#variable-naming Also implement config aliasing, for pain-free settings migrations in the future
2021-01-07 11:37:38 +00:00
[[rust-analyzer.assist.importMergeBehavior]]rust-analyzer.assist.importMergeBehavior (default: `"full"`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
The strategy to use when inserting new imports or merging imports.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.assist.importPrefix]]rust-analyzer.assist.importPrefix (default: `"plain"`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
The path structure for newly inserted paths to use.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.callInfo.full]]rust-analyzer.callInfo.full (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Show function name and docs in parameter hints.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.cargo.autoreload]]rust-analyzer.cargo.autoreload (default: `true`)::
Clean up descriptions for settings Use two consecutive newlines (`\n\n`) to actually continue text on a new line. Use proper markup to reference related settings. Consistently format references to files, editor commands, command line arguments, files, etc. as `code`. Fix typos, add missing full-stops, add missing default values.
2020-12-22 00:15:50 +00:00
Automatically refresh project info via `cargo metadata` on `Cargo.toml` changes.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.cargo.allFeatures]]rust-analyzer.cargo.allFeatures (default: `false`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Activate all available features.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.cargo.features]]rust-analyzer.cargo.features (default: `[]`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
List of features to activate.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.cargo.loadOutDirsFromCheck]]rust-analyzer.cargo.loadOutDirsFromCheck (default: `false`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Run `cargo check` on startup to get the correct value for package OUT_DIRs.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.cargo.noDefaultFeatures]]rust-analyzer.cargo.noDefaultFeatures (default: `false`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Do not activate the `default` feature.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.cargo.target]]rust-analyzer.cargo.target (default: `null`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Compilation target (target triple).
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.cargo.noSysroot]]rust-analyzer.cargo.noSysroot (default: `false`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Internal config for debugging, disables loading of sysroot crates.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.checkOnSave.enable]]rust-analyzer.checkOnSave.enable (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Run specified `cargo check` command for diagnostics on save.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.checkOnSave.allFeatures]]rust-analyzer.checkOnSave.allFeatures (default: `null`)::
Clean up descriptions for settings Use two consecutive newlines (`\n\n`) to actually continue text on a new line. Use proper markup to reference related settings. Consistently format references to files, editor commands, command line arguments, files, etc. as `code`. Fix typos, add missing full-stops, add missing default values.
2020-12-22 00:15:50 +00:00
Check with all features (will be passed as `--all-features`). Defaults to `#rust-analyzer.cargo.allFeatures#`.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.checkOnSave.allTargets]]rust-analyzer.checkOnSave.allTargets (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Check all targets and tests (will be passed as `--all-targets`).
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.checkOnSave.command]]rust-analyzer.checkOnSave.command (default: `"check"`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Cargo command to use for `cargo check`.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.checkOnSave.noDefaultFeatures]]rust-analyzer.checkOnSave.noDefaultFeatures (default: `null`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Do not activate the `default` feature.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.checkOnSave.target]]rust-analyzer.checkOnSave.target (default: `null`)::
Clean up descriptions for settings Use two consecutive newlines (`\n\n`) to actually continue text on a new line. Use proper markup to reference related settings. Consistently format references to files, editor commands, command line arguments, files, etc. as `code`. Fix typos, add missing full-stops, add missing default values.
2020-12-22 00:15:50 +00:00
Check for a specific target. Defaults to `#rust-analyzer.cargo.target#`.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.checkOnSave.extraArgs]]rust-analyzer.checkOnSave.extraArgs (default: `[]`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Extra arguments for `cargo check`.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.checkOnSave.features]]rust-analyzer.checkOnSave.features (default: `null`)::
Clean up descriptions for settings Use two consecutive newlines (`\n\n`) to actually continue text on a new line. Use proper markup to reference related settings. Consistently format references to files, editor commands, command line arguments, files, etc. as `code`. Fix typos, add missing full-stops, add missing default values.
2020-12-22 00:15:50 +00:00
List of features to activate. Defaults to `#rust-analyzer.cargo.features#`.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.checkOnSave.overrideCommand]]rust-analyzer.checkOnSave.overrideCommand (default: `null`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Advanced option, fully override the command rust-analyzer uses for checking. The command should include `--message-format=json` or similar option.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.completion.addCallArgumentSnippets]]rust-analyzer.completion.addCallArgumentSnippets (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Whether to add argument snippets when completing functions.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.completion.addCallParenthesis]]rust-analyzer.completion.addCallParenthesis (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Whether to add parenthesis when completing functions.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.completion.postfix.enable]]rust-analyzer.completion.postfix.enable (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Whether to show postfix snippets like `dbg`, `if`, `not`, etc.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.completion.autoimport.enable]]rust-analyzer.completion.autoimport.enable (default: `true`)::
Clean up descriptions for settings Use two consecutive newlines (`\n\n`) to actually continue text on a new line. Use proper markup to reference related settings. Consistently format references to files, editor commands, command line arguments, files, etc. as `code`. Fix typos, add missing full-stops, add missing default values.
2020-12-22 00:15:50 +00:00
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.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.diagnostics.enable]]rust-analyzer.diagnostics.enable (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Whether to show native rust-analyzer diagnostics.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.diagnostics.enableExperimental]]rust-analyzer.diagnostics.enableExperimental (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Whether to show experimental rust-analyzer diagnostics that might have more false positives than usual.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.diagnostics.disabled]]rust-analyzer.diagnostics.disabled (default: `[]`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
List of rust-analyzer diagnostics to disable.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.diagnostics.warningsAsHint]]rust-analyzer.diagnostics.warningsAsHint (default: `[]`)::
Clean up descriptions for settings Use two consecutive newlines (`\n\n`) to actually continue text on a new line. Use proper markup to reference related settings. Consistently format references to files, editor commands, command line arguments, files, etc. as `code`. Fix typos, add missing full-stops, add missing default values.
2020-12-22 00:15:50 +00:00
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`.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.diagnostics.warningsAsInfo]]rust-analyzer.diagnostics.warningsAsInfo (default: `[]`)::
Clean up descriptions for settings Use two consecutive newlines (`\n\n`) to actually continue text on a new line. Use proper markup to reference related settings. Consistently format references to files, editor commands, command line arguments, files, etc. as `code`. Fix typos, add missing full-stops, add missing default values.
2020-12-22 00:15:50 +00:00
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`.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.files.watcher]]rust-analyzer.files.watcher (default: `"client"`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Controls file watching implementation.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.hoverActions.debug]]rust-analyzer.hoverActions.debug (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Whether to show `Debug` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.hoverActions.enable]]rust-analyzer.hoverActions.enable (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Whether to show HoverActions in Rust files.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.hoverActions.gotoTypeDef]]rust-analyzer.hoverActions.gotoTypeDef (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Whether to show `Go to Type Definition` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.hoverActions.implementations]]rust-analyzer.hoverActions.implementations (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Whether to show `Implementations` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.hoverActions.run]]rust-analyzer.hoverActions.run (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Whether to show `Run` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.hoverActions.linksInHover]]rust-analyzer.hoverActions.linksInHover (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Use markdown syntax for links in hover.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.inlayHints.chainingHints]]rust-analyzer.inlayHints.chainingHints (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Whether to show inlay type hints for method chains.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.inlayHints.maxLength]]rust-analyzer.inlayHints.maxLength (default: `null`)::
Clean up descriptions for settings Use two consecutive newlines (`\n\n`) to actually continue text on a new line. Use proper markup to reference related settings. Consistently format references to files, editor commands, command line arguments, files, etc. as `code`. Fix typos, add missing full-stops, add missing default values.
2020-12-22 00:15:50 +00:00
Maximum length for inlay hints. Default is unlimited.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.inlayHints.parameterHints]]rust-analyzer.inlayHints.parameterHints (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Whether to show function parameter name inlay hints at the call site.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.inlayHints.typeHints]]rust-analyzer.inlayHints.typeHints (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Whether to show inlay type hints for variables.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.lens.debug]]rust-analyzer.lens.debug (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Whether to show `Debug` lens. Only applies when `#rust-analyzer.lens.enable#` is set.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.lens.enable]]rust-analyzer.lens.enable (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Whether to show CodeLens in Rust files.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.lens.implementations]]rust-analyzer.lens.implementations (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Whether to show `Implementations` lens. Only applies when `#rust-analyzer.lens.enable#` is set.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.lens.run]]rust-analyzer.lens.run (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Whether to show `Run` lens. Only applies when `#rust-analyzer.lens.enable#` is set.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.lens.methodReferences]]rust-analyzer.lens.methodReferences (default: `false`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Whether to show `Method References` lens. Only applies when `#rust-analyzer.lens.enable#` is set.
Add References code lens. For Struct, Enum, Union and Trait symbols.
2021-01-23 13:56:20 +00:00
[[rust-analyzer.lens.references]]rust-analyzer.lens.references (default: `false`)::
Whether to show `References` lens. Only applies when `#rust-analyzer.lens.enable#` is set.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.linkedProjects]]rust-analyzer.linkedProjects (default: `[]`)::
Clean up descriptions for settings Use two consecutive newlines (`\n\n`) to actually continue text on a new line. Use proper markup to reference related settings. Consistently format references to files, editor commands, command line arguments, files, etc. as `code`. Fix typos, add missing full-stops, add missing default values.
2020-12-22 00:15:50 +00:00
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.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.lruCapacity]]rust-analyzer.lruCapacity (default: `null`)::
Clean up descriptions for settings Use two consecutive newlines (`\n\n`) to actually continue text on a new line. Use proper markup to reference related settings. Consistently format references to files, editor commands, command line arguments, files, etc. as `code`. Fix typos, add missing full-stops, add missing default values.
2020-12-22 00:15:50 +00:00
Number of syntax trees rust-analyzer keeps in memory. Defaults to 128.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.notifications.cargoTomlNotFound]]rust-analyzer.notifications.cargoTomlNotFound (default: `true`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Whether to show `can't find Cargo.toml` error message.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.procMacro.enable]]rust-analyzer.procMacro.enable (default: `false`)::
Clean up descriptions for settings Use two consecutive newlines (`\n\n`) to actually continue text on a new line. Use proper markup to reference related settings. Consistently format references to files, editor commands, command line arguments, files, etc. as `code`. Fix typos, add missing full-stops, add missing default values.
2020-12-22 00:15:50 +00:00
Enable Proc macro support, `#rust-analyzer.cargo.loadOutDirsFromCheck#` must be enabled.
More maintainable config Rather than eagerly converting JSON, we losslessly keep it as is, and change the shape of user-submitted data at the last moment. This also allows us to remove a bunch of wrong Defaults
2021-01-06 10:54:28 +00:00
[[rust-analyzer.procMacro.server]]rust-analyzer.procMacro.server (default: `null`)::
Internal config, path to proc-macro server executable (typically, this is rust-analyzer itself, but we override this in tests).
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.runnables.overrideCargo]]rust-analyzer.runnables.overrideCargo (default: `null`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Command to be executed instead of 'cargo' for runnables.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.runnables.cargoExtraArgs]]rust-analyzer.runnables.cargoExtraArgs (default: `[]`)::
Clean up descriptions for settings Use two consecutive newlines (`\n\n`) to actually continue text on a new line. Use proper markup to reference related settings. Consistently format references to files, editor commands, command line arguments, files, etc. as `code`. Fix typos, add missing full-stops, add missing default values.
2020-12-22 00:15:50 +00:00
Additional arguments to be passed to cargo for runnables such as tests or binaries.\nFor example, it may be `--release`.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.rustcSource]]rust-analyzer.rustcSource (default: `null`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Path to the rust compiler sources, for usage in rustc_private projects.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.rustfmt.extraArgs]]rust-analyzer.rustfmt.extraArgs (default: `[]`)::
Clean up descriptions for settings Use two consecutive newlines (`\n\n`) to actually continue text on a new line. Use proper markup to reference related settings. Consistently format references to files, editor commands, command line arguments, files, etc. as `code`. Fix typos, add missing full-stops, add missing default values.
2020-12-22 00:15:50 +00:00
Additional arguments to `rustfmt`.
Allow `#anchor` linking of config options
2021-01-05 10:09:06 +00:00
[[rust-analyzer.rustfmt.overrideCommand]]rust-analyzer.rustfmt.overrideCommand (default: `null`)::
Include config into the manual
2020-12-09 12:07:37 +00:00
Advanced option, fully override the command rust-analyzer uses for formatting.
Reference in a new issue Copy permalink