mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
42da26e959
rust/docs/user/generated_config.adoc

107 lines
6.9 KiB
Plaintext
Raw Normal View History

Include config into the manual
2020-12-09 06:07:37 -06:00
rust-analyzer.assist.importMergeBehaviour (default: `"full"`)::
The strategy to use when inserting new imports or merging imports.
rust-analyzer.assist.importPrefix (default: `"plain"`)::
The path structure for newly inserted paths to use.
rust-analyzer.callInfo.full (default: `true`)::
Show function name and docs in parameter hints.
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-21 18:15:50 -06:00
Automatically refresh project info via `cargo metadata` on `Cargo.toml` changes.
Include config into the manual
2020-12-09 06:07:37 -06:00
rust-analyzer.cargo.allFeatures (default: `false`)::
Activate all available features.
rust-analyzer.cargo.features (default: `[]`)::
List of features to activate.
rust-analyzer.cargo.loadOutDirsFromCheck (default: `false`)::
Run `cargo check` on startup to get the correct value for package OUT_DIRs.
rust-analyzer.cargo.noDefaultFeatures (default: `false`)::
Do not activate the `default` feature.
rust-analyzer.cargo.target (default: `null`)::
Compilation target (target triple).
rust-analyzer.cargo.noSysroot (default: `false`)::
Internal config for debugging, disables loading of sysroot crates.
rust-analyzer.checkOnSave.enable (default: `true`)::
Run specified `cargo check` command for diagnostics on save.
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-21 18:15:50 -06:00
Check with all features (will be passed as `--all-features`). Defaults to `#rust-analyzer.cargo.allFeatures#`.
Include config into the manual
2020-12-09 06:07:37 -06:00
rust-analyzer.checkOnSave.allTargets (default: `true`)::
Check all targets and tests (will be passed as `--all-targets`).
rust-analyzer.checkOnSave.command (default: `"check"`)::
Cargo command to use for `cargo check`.
rust-analyzer.checkOnSave.noDefaultFeatures (default: `null`)::
Do not activate the `default` feature.
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-21 18:15:50 -06:00
Check for a specific target. Defaults to `#rust-analyzer.cargo.target#`.
Include config into the manual
2020-12-09 06:07:37 -06:00
rust-analyzer.checkOnSave.extraArgs (default: `[]`)::
Extra arguments for `cargo check`.
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-21 18:15:50 -06:00
List of features to activate. Defaults to `#rust-analyzer.cargo.features#`.
Include config into the manual
2020-12-09 06:07:37 -06:00
rust-analyzer.checkOnSave.overrideCommand (default: `null`)::
Advanced option, fully override the command rust-analyzer uses for checking. The command should include `--message-format=json` or similar option.
rust-analyzer.completion.addCallArgumentSnippets (default: `true`)::
Whether to add argument snippets when completing functions.
rust-analyzer.completion.addCallParenthesis (default: `true`)::
Whether to add parenthesis when completing functions.
rust-analyzer.completion.postfix.enable (default: `true`)::
Whether to show postfix snippets like `dbg`, `if`, `not`, etc.
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-21 18:15:50 -06: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.
Include config into the manual
2020-12-09 06:07:37 -06:00
rust-analyzer.diagnostics.enable (default: `true`)::
Whether to show native rust-analyzer diagnostics.
rust-analyzer.diagnostics.enableExperimental (default: `true`)::
Whether to show experimental rust-analyzer diagnostics that might have more false positives than usual.
rust-analyzer.diagnostics.disabled (default: `[]`)::
List of rust-analyzer diagnostics to disable.
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-21 18:15:50 -06: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`.
Include config into the manual
2020-12-09 06:07:37 -06:00
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-21 18:15:50 -06: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`.
Include config into the manual
2020-12-09 06:07:37 -06:00
rust-analyzer.files.watcher (default: `"client"`)::
Controls file watching implementation.
rust-analyzer.hoverActions.debug (default: `true`)::
Whether to show `Debug` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set.
rust-analyzer.hoverActions.enable (default: `true`)::
Whether to show HoverActions in Rust files.
rust-analyzer.hoverActions.gotoTypeDef (default: `true`)::
Whether to show `Go to Type Definition` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set.
rust-analyzer.hoverActions.implementations (default: `true`)::
Whether to show `Implementations` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set.
rust-analyzer.hoverActions.run (default: `true`)::
Whether to show `Run` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set.
rust-analyzer.hoverActions.linksInHover (default: `true`)::
Use markdown syntax for links in hover.
rust-analyzer.inlayHints.chainingHints (default: `true`)::
Whether to show inlay type hints for method chains.
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-21 18:15:50 -06:00
Maximum length for inlay hints. Default is unlimited.
Include config into the manual
2020-12-09 06:07:37 -06:00
rust-analyzer.inlayHints.parameterHints (default: `true`)::
Whether to show function parameter name inlay hints at the call site.
rust-analyzer.inlayHints.typeHints (default: `true`)::
Whether to show inlay type hints for variables.
rust-analyzer.lens.debug (default: `true`)::
Whether to show `Debug` lens. Only applies when `#rust-analyzer.lens.enable#` is set.
rust-analyzer.lens.enable (default: `true`)::
Whether to show CodeLens in Rust files.
rust-analyzer.lens.implementations (default: `true`)::
Whether to show `Implementations` lens. Only applies when `#rust-analyzer.lens.enable#` is set.
rust-analyzer.lens.run (default: `true`)::
Whether to show `Run` lens. Only applies when `#rust-analyzer.lens.enable#` is set.
rust-analyzer.lens.methodReferences (default: `false`)::
Whether to show `Method References` lens. Only applies when `#rust-analyzer.lens.enable#` is set.
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-21 18:15:50 -06: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.
Include config into the manual
2020-12-09 06:07:37 -06:00
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-21 18:15:50 -06:00
Number of syntax trees rust-analyzer keeps in memory. Defaults to 128.
Include config into the manual
2020-12-09 06:07:37 -06:00
rust-analyzer.notifications.cargoTomlNotFound (default: `true`)::
Whether to show `can't find Cargo.toml` error message.
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-21 18:15:50 -06:00
Enable Proc macro support, `#rust-analyzer.cargo.loadOutDirsFromCheck#` must be enabled.
Include config into the manual
2020-12-09 06:07:37 -06:00
rust-analyzer.runnables.overrideCargo (default: `null`)::
Command to be executed instead of 'cargo' for runnables.
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-21 18:15:50 -06:00
Additional arguments to be passed to cargo for runnables such as tests or binaries.\nFor example, it may be `--release`.
Include config into the manual
2020-12-09 06:07:37 -06:00
rust-analyzer.rustcSource (default: `null`)::
Path to the rust compiler sources, for usage in rustc_private projects.
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-21 18:15:50 -06:00
Additional arguments to `rustfmt`.
Include config into the manual
2020-12-09 06:07:37 -06:00
rust-analyzer.rustfmt.overrideCommand (default: `null`)::
Advanced option, fully override the command rust-analyzer uses for formatting.
Reference in New Issue Copy Permalink