| [[rust-analyzer.assist.emitMustUse]]rust-analyzer.assist.emitMustUse (default: `false`):: |
| + |
| -- |
| Whether to insert #[must_use] when generating `as_` methods |
| for enum variants. |
| -- |
| [[rust-analyzer.assist.expressionFillDefault]]rust-analyzer.assist.expressionFillDefault (default: `"todo"`):: |
| + |
| -- |
| Placeholder expression to use for missing expressions in assists. |
| -- |
| [[rust-analyzer.assist.termSearch.borrowcheck]]rust-analyzer.assist.termSearch.borrowcheck (default: `true`):: |
| + |
| -- |
| Enable borrow checking for term search code assists. If set to false, also there will be more suggestions, but some of them may not borrow-check. |
| -- |
| [[rust-analyzer.assist.termSearch.fuel]]rust-analyzer.assist.termSearch.fuel (default: `1800`):: |
| + |
| -- |
| Term search fuel in "units of work" for assists (Defaults to 1800). |
| -- |
| [[rust-analyzer.cachePriming.enable]]rust-analyzer.cachePriming.enable (default: `true`):: |
| + |
| -- |
| Warm up caches on project load. |
| -- |
| [[rust-analyzer.cachePriming.numThreads]]rust-analyzer.cachePriming.numThreads (default: `"physical"`):: |
| + |
| -- |
| How many worker threads to handle priming caches. The default `0` means to pick automatically. |
| -- |
| [[rust-analyzer.cargo.allTargets]]rust-analyzer.cargo.allTargets (default: `true`):: |
| + |
| -- |
| Pass `--all-targets` to cargo invocation. |
| -- |
| [[rust-analyzer.cargo.autoreload]]rust-analyzer.cargo.autoreload (default: `true`):: |
| + |
| -- |
| Automatically refresh project info via `cargo metadata` on |
| `Cargo.toml` or `.cargo/config.toml` changes. |
| -- |
| [[rust-analyzer.cargo.buildScripts.enable]]rust-analyzer.cargo.buildScripts.enable (default: `true`):: |
| + |
| -- |
| Run build scripts (`build.rs`) for more precise code analysis. |
| -- |
| [[rust-analyzer.cargo.buildScripts.invocationStrategy]]rust-analyzer.cargo.buildScripts.invocationStrategy (default: `"per_workspace"`):: |
| + |
| -- |
| Specifies the invocation strategy to use when running the build scripts command. |
| If `per_workspace` is set, the command will be executed for each Rust workspace with the |
| workspace as the working directory. |
| If `once` is set, the command will be executed once with the opened project as the |
| working directory. |
| This config only has an effect when `#rust-analyzer.cargo.buildScripts.overrideCommand#` |
| is set. |
| -- |
| [[rust-analyzer.cargo.buildScripts.overrideCommand]]rust-analyzer.cargo.buildScripts.overrideCommand (default: `null`):: |
| + |
| -- |
| Override the command rust-analyzer uses to run build scripts and |
| build procedural macros. The command is required to output json |
| and should therefore include `--message-format=json` or a similar |
| option. |
| |
| If there are multiple linked projects/workspaces, this command is invoked for |
| each of them, with the working directory being the workspace root |
| (i.e., the folder containing the `Cargo.toml`). This can be overwritten |
| by changing `#rust-analyzer.cargo.buildScripts.invocationStrategy#`. |
| |
| By default, a cargo invocation will be constructed for the configured |
| targets and features, with the following base command line: |
| |
| ```bash |
| cargo check --quiet --workspace --message-format=json --all-targets --keep-going |
| ``` |
| . |
| -- |
| [[rust-analyzer.cargo.buildScripts.rebuildOnSave]]rust-analyzer.cargo.buildScripts.rebuildOnSave (default: `true`):: |
| + |
| -- |
| Rerun proc-macros building/build-scripts running when proc-macro |
| or build-script sources change and are saved. |
| -- |
| [[rust-analyzer.cargo.buildScripts.useRustcWrapper]]rust-analyzer.cargo.buildScripts.useRustcWrapper (default: `true`):: |
| + |
| -- |
| Use `RUSTC_WRAPPER=rust-analyzer` when running build scripts to |
| avoid checking unnecessary things. |
| -- |
| [[rust-analyzer.cargo.cfgs]]rust-analyzer.cargo.cfgs:: |
| + |
| -- |
| Default: |
| ---- |
| { |
| "debug_assertions": null, |
| "miri": null |
| } |
| ---- |
| List of cfg options to enable with the given values. |
| |
| -- |
| [[rust-analyzer.cargo.extraArgs]]rust-analyzer.cargo.extraArgs (default: `[]`):: |
| + |
| -- |
| Extra arguments that are passed to every cargo invocation. |
| -- |
| [[rust-analyzer.cargo.extraEnv]]rust-analyzer.cargo.extraEnv (default: `{}`):: |
| + |
| -- |
| Extra environment variables that will be set when running cargo, rustc |
| or other commands within the workspace. Useful for setting RUSTFLAGS. |
| -- |
| [[rust-analyzer.cargo.features]]rust-analyzer.cargo.features (default: `[]`):: |
| + |
| -- |
| List of features to activate. |
| |
| Set this to `"all"` to pass `--all-features` to cargo. |
| -- |
| [[rust-analyzer.cargo.noDefaultFeatures]]rust-analyzer.cargo.noDefaultFeatures (default: `false`):: |
| + |
| -- |
| Whether to pass `--no-default-features` to cargo. |
| -- |
| [[rust-analyzer.cargo.sysroot]]rust-analyzer.cargo.sysroot (default: `"discover"`):: |
| + |
| -- |
| Relative path to the sysroot, or "discover" to try to automatically find it via |
| "rustc --print sysroot". |
| |
| Unsetting this disables sysroot loading. |
| |
| This option does not take effect until rust-analyzer is restarted. |
| -- |
| [[rust-analyzer.cargo.sysrootSrc]]rust-analyzer.cargo.sysrootSrc (default: `null`):: |
| + |
| -- |
| Relative path to the sysroot library sources. If left unset, this will default to |
| `{cargo.sysroot}/lib/rustlib/src/rust/library`. |
| |
| This option does not take effect until rust-analyzer is restarted. |
| -- |
| [[rust-analyzer.cargo.target]]rust-analyzer.cargo.target (default: `null`):: |
| + |
| -- |
| Compilation target override (target triple). |
| -- |
| [[rust-analyzer.cargo.targetDir]]rust-analyzer.cargo.targetDir (default: `null`):: |
| + |
| -- |
| Optional path to a rust-analyzer specific target directory. |
| This prevents rust-analyzer's `cargo check` and initial build-script and proc-macro |
| building from locking the `Cargo.lock` at the expense of duplicating build artifacts. |
| |
| Set to `true` to use a subdirectory of the existing target directory or |
| set to a path relative to the workspace to use that path. |
| -- |
| [[rust-analyzer.cfg.setTest]]rust-analyzer.cfg.setTest (default: `true`):: |
| + |
| -- |
| Set `cfg(test)` for local crates. Defaults to true. |
| -- |
| [[rust-analyzer.checkOnSave]]rust-analyzer.checkOnSave (default: `true`):: |
| + |
| -- |
| Run the check command for diagnostics on save. |
| -- |
| [[rust-analyzer.check.allTargets]]rust-analyzer.check.allTargets (default: `null`):: |
| + |
| -- |
| Check all targets and tests (`--all-targets`). Defaults to |
| `#rust-analyzer.cargo.allTargets#`. |
| -- |
| [[rust-analyzer.check.command]]rust-analyzer.check.command (default: `"check"`):: |
| + |
| -- |
| Cargo command to use for `cargo check`. |
| -- |
| [[rust-analyzer.check.extraArgs]]rust-analyzer.check.extraArgs (default: `[]`):: |
| + |
| -- |
| Extra arguments for `cargo check`. |
| -- |
| [[rust-analyzer.check.extraEnv]]rust-analyzer.check.extraEnv (default: `{}`):: |
| + |
| -- |
| Extra environment variables that will be set when running `cargo check`. |
| Extends `#rust-analyzer.cargo.extraEnv#`. |
| -- |
| [[rust-analyzer.check.features]]rust-analyzer.check.features (default: `null`):: |
| + |
| -- |
| List of features to activate. Defaults to |
| `#rust-analyzer.cargo.features#`. |
| |
| Set to `"all"` to pass `--all-features` to Cargo. |
| -- |
| [[rust-analyzer.check.ignore]]rust-analyzer.check.ignore (default: `[]`):: |
| + |
| -- |
| List of `cargo check` (or other command specified in `check.command`) diagnostics to ignore. |
| |
| For example for `cargo check`: `dead_code`, `unused_imports`, `unused_variables`,... |
| -- |
| [[rust-analyzer.check.invocationStrategy]]rust-analyzer.check.invocationStrategy (default: `"per_workspace"`):: |
| + |
| -- |
| Specifies the invocation strategy to use when running the check command. |
| If `per_workspace` is set, the command will be executed for each workspace. |
| If `once` is set, the command will be executed once. |
| This config only has an effect when `#rust-analyzer.check.overrideCommand#` |
| is set. |
| -- |
| [[rust-analyzer.check.noDefaultFeatures]]rust-analyzer.check.noDefaultFeatures (default: `null`):: |
| + |
| -- |
| Whether to pass `--no-default-features` to Cargo. Defaults to |
| `#rust-analyzer.cargo.noDefaultFeatures#`. |
| -- |
| [[rust-analyzer.check.overrideCommand]]rust-analyzer.check.overrideCommand (default: `null`):: |
| + |
| -- |
| Override the command rust-analyzer uses instead of `cargo check` for |
| diagnostics on save. The command is required to output json and |
| should therefore include `--message-format=json` or a similar option |
| (if your client supports the `colorDiagnosticOutput` experimental |
| capability, you can use `--message-format=json-diagnostic-rendered-ansi`). |
| |
| If you're changing this because you're using some tool wrapping |
| Cargo, you might also want to change |
| `#rust-analyzer.cargo.buildScripts.overrideCommand#`. |
| |
| If there are multiple linked projects/workspaces, this command is invoked for |
| each of them, with the working directory being the workspace root |
| (i.e., the folder containing the `Cargo.toml`). This can be overwritten |
| by changing `#rust-analyzer.check.invocationStrategy#`. |
| |
| If `$saved_file` is part of the command, rust-analyzer will pass |
| the absolute path of the saved file to the provided command. This is |
| intended to be used with non-Cargo build systems. |
| Note that `$saved_file` is experimental and may be removed in the future. |
| |
| An example command would be: |
| |
| ```bash |
| cargo check --workspace --message-format=json --all-targets |
| ``` |
| . |
| -- |
| [[rust-analyzer.check.targets]]rust-analyzer.check.targets (default: `null`):: |
| + |
| -- |
| Check for specific targets. Defaults to `#rust-analyzer.cargo.target#` if empty. |
| |
| Can be a single target, e.g. `"x86_64-unknown-linux-gnu"` or a list of targets, e.g. |
| `["aarch64-apple-darwin", "x86_64-apple-darwin"]`. |
| |
| Aliased as `"checkOnSave.targets"`. |
| -- |
| [[rust-analyzer.check.workspace]]rust-analyzer.check.workspace (default: `true`):: |
| + |
| -- |
| Whether `--workspace` should be passed to `cargo check`. |
| If false, `-p <package>` will be passed instead. |
| -- |
| [[rust-analyzer.completion.addSemicolonToUnit]]rust-analyzer.completion.addSemicolonToUnit (default: `true`):: |
| + |
| -- |
| Whether to automatically add a semicolon when completing unit-returning functions. |
| |
| In `match` arms it completes a comma instead. |
| -- |
| [[rust-analyzer.completion.autoimport.enable]]rust-analyzer.completion.autoimport.enable (default: `true`):: |
| + |
| -- |
| 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. |
| -- |
| [[rust-analyzer.completion.autoself.enable]]rust-analyzer.completion.autoself.enable (default: `true`):: |
| + |
| -- |
| Toggles the additional completions that automatically show method calls and field accesses |
| with `self` prefixed to them when inside a method. |
| -- |
| [[rust-analyzer.completion.callable.snippets]]rust-analyzer.completion.callable.snippets (default: `"fill_arguments"`):: |
| + |
| -- |
| Whether to add parenthesis and argument snippets when completing function. |
| -- |
| [[rust-analyzer.completion.fullFunctionSignatures.enable]]rust-analyzer.completion.fullFunctionSignatures.enable (default: `false`):: |
| + |
| -- |
| Whether to show full function/method signatures in completion docs. |
| -- |
| [[rust-analyzer.completion.hideDeprecated]]rust-analyzer.completion.hideDeprecated (default: `false`):: |
| + |
| -- |
| Whether to omit deprecated items from autocompletion. By default they are marked as deprecated but not hidden. |
| -- |
| [[rust-analyzer.completion.limit]]rust-analyzer.completion.limit (default: `null`):: |
| + |
| -- |
| Maximum number of completions to return. If `None`, the limit is infinite. |
| -- |
| [[rust-analyzer.completion.postfix.enable]]rust-analyzer.completion.postfix.enable (default: `true`):: |
| + |
| -- |
| Whether to show postfix snippets like `dbg`, `if`, `not`, etc. |
| -- |
| [[rust-analyzer.completion.privateEditable.enable]]rust-analyzer.completion.privateEditable.enable (default: `false`):: |
| + |
| -- |
| Enables completions of private items and fields that are defined in the current workspace even if they are not visible at the current position. |
| -- |
| [[rust-analyzer.completion.snippets.custom]]rust-analyzer.completion.snippets.custom:: |
| + |
| -- |
| Default: |
| ---- |
| { |
| "Arc::new": { |
| "postfix": "arc", |
| "body": "Arc::new(${receiver})", |
| "requires": "std::sync::Arc", |
| "description": "Put the expression into an `Arc`", |
| "scope": "expr" |
| }, |
| "Rc::new": { |
| "postfix": "rc", |
| "body": "Rc::new(${receiver})", |
| "requires": "std::rc::Rc", |
| "description": "Put the expression into an `Rc`", |
| "scope": "expr" |
| }, |
| "Box::pin": { |
| "postfix": "pinbox", |
| "body": "Box::pin(${receiver})", |
| "requires": "std::boxed::Box", |
| "description": "Put the expression into a pinned `Box`", |
| "scope": "expr" |
| }, |
| "Err": { |
| "postfix": "err", |
| "body": "Err(${receiver})", |
| "description": "Wrap the expression in a `Result::Err`", |
| "scope": "expr" |
| }, |
| "Some": { |
| "postfix": "some", |
| "body": "Some(${receiver})", |
| "description": "Wrap the expression in an `Option::Some`", |
| "scope": "expr" |
| }, |
| "Ok": { |
| "postfix": "ok", |
| "body": "Ok(${receiver})", |
| "description": "Wrap the expression in a `Result::Ok`", |
| "scope": "expr" |
| } |
| } |
| ---- |
| Custom completion snippets. |
| |
| -- |
| [[rust-analyzer.completion.termSearch.enable]]rust-analyzer.completion.termSearch.enable (default: `false`):: |
| + |
| -- |
| Whether to enable term search based snippets like `Some(foo.bar().baz())`. |
| -- |
| [[rust-analyzer.completion.termSearch.fuel]]rust-analyzer.completion.termSearch.fuel (default: `1000`):: |
| + |
| -- |
| Term search fuel in "units of work" for autocompletion (Defaults to 1000). |
| -- |
| [[rust-analyzer.diagnostics.disabled]]rust-analyzer.diagnostics.disabled (default: `[]`):: |
| + |
| -- |
| List of rust-analyzer diagnostics to disable. |
| -- |
| [[rust-analyzer.diagnostics.enable]]rust-analyzer.diagnostics.enable (default: `true`):: |
| + |
| -- |
| Whether to show native rust-analyzer diagnostics. |
| -- |
| [[rust-analyzer.diagnostics.experimental.enable]]rust-analyzer.diagnostics.experimental.enable (default: `false`):: |
| + |
| -- |
| Whether to show experimental rust-analyzer diagnostics that might |
| have more false positives than usual. |
| -- |
| [[rust-analyzer.diagnostics.remapPrefix]]rust-analyzer.diagnostics.remapPrefix (default: `{}`):: |
| + |
| -- |
| Map of prefixes to be substituted when parsing diagnostic file paths. |
| This should be the reverse mapping of what is passed to `rustc` as `--remap-path-prefix`. |
| -- |
| [[rust-analyzer.diagnostics.styleLints.enable]]rust-analyzer.diagnostics.styleLints.enable (default: `false`):: |
| + |
| -- |
| Whether to run additional style lints. |
| -- |
| [[rust-analyzer.diagnostics.warningsAsHint]]rust-analyzer.diagnostics.warningsAsHint (default: `[]`):: |
| + |
| -- |
| List of warnings that should be displayed with hint severity. |
| |
| The warnings will be indicated by faded text or three dots in code |
| and will not show up in the `Problems Panel`. |
| -- |
| [[rust-analyzer.diagnostics.warningsAsInfo]]rust-analyzer.diagnostics.warningsAsInfo (default: `[]`):: |
| + |
| -- |
| List of warnings that should be displayed with info severity. |
| |
| The warnings will be indicated by a blue squiggly underline in code |
| and a blue icon in the `Problems Panel`. |
| -- |
| [[rust-analyzer.files.excludeDirs]]rust-analyzer.files.excludeDirs (default: `[]`):: |
| + |
| -- |
| These directories will be ignored by rust-analyzer. They are |
| relative to the workspace root, and globs are not supported. You may |
| also need to add the folders to Code's `files.watcherExclude`. |
| -- |
| [[rust-analyzer.files.watcher]]rust-analyzer.files.watcher (default: `"client"`):: |
| + |
| -- |
| Controls file watching implementation. |
| -- |
| [[rust-analyzer.highlightRelated.breakPoints.enable]]rust-analyzer.highlightRelated.breakPoints.enable (default: `true`):: |
| + |
| -- |
| Enables highlighting of related references while the cursor is on `break`, `loop`, `while`, or `for` keywords. |
| -- |
| [[rust-analyzer.highlightRelated.closureCaptures.enable]]rust-analyzer.highlightRelated.closureCaptures.enable (default: `true`):: |
| + |
| -- |
| Enables highlighting of all captures of a closure while the cursor is on the `|` or move keyword of a closure. |
| -- |
| [[rust-analyzer.highlightRelated.exitPoints.enable]]rust-analyzer.highlightRelated.exitPoints.enable (default: `true`):: |
| + |
| -- |
| Enables highlighting of all exit points while the cursor is on any `return`, `?`, `fn`, or return type arrow (`->`). |
| -- |
| [[rust-analyzer.highlightRelated.references.enable]]rust-analyzer.highlightRelated.references.enable (default: `true`):: |
| + |
| -- |
| Enables highlighting of related references while the cursor is on any identifier. |
| -- |
| [[rust-analyzer.highlightRelated.yieldPoints.enable]]rust-analyzer.highlightRelated.yieldPoints.enable (default: `true`):: |
| + |
| -- |
| Enables highlighting of all break points for a loop or block context while the cursor is on any `async` or `await` keywords. |
| -- |
| [[rust-analyzer.hover.actions.debug.enable]]rust-analyzer.hover.actions.debug.enable (default: `true`):: |
| + |
| -- |
| Whether to show `Debug` action. Only applies when |
| `#rust-analyzer.hover.actions.enable#` is set. |
| -- |
| [[rust-analyzer.hover.actions.enable]]rust-analyzer.hover.actions.enable (default: `true`):: |
| + |
| -- |
| Whether to show HoverActions in Rust files. |
| -- |
| [[rust-analyzer.hover.actions.gotoTypeDef.enable]]rust-analyzer.hover.actions.gotoTypeDef.enable (default: `true`):: |
| + |
| -- |
| Whether to show `Go to Type Definition` action. Only applies when |
| `#rust-analyzer.hover.actions.enable#` is set. |
| -- |
| [[rust-analyzer.hover.actions.implementations.enable]]rust-analyzer.hover.actions.implementations.enable (default: `true`):: |
| + |
| -- |
| Whether to show `Implementations` action. Only applies when |
| `#rust-analyzer.hover.actions.enable#` is set. |
| -- |
| [[rust-analyzer.hover.actions.references.enable]]rust-analyzer.hover.actions.references.enable (default: `false`):: |
| + |
| -- |
| Whether to show `References` action. Only applies when |
| `#rust-analyzer.hover.actions.enable#` is set. |
| -- |
| [[rust-analyzer.hover.actions.run.enable]]rust-analyzer.hover.actions.run.enable (default: `true`):: |
| + |
| -- |
| Whether to show `Run` action. Only applies when |
| `#rust-analyzer.hover.actions.enable#` is set. |
| -- |
| [[rust-analyzer.hover.documentation.enable]]rust-analyzer.hover.documentation.enable (default: `true`):: |
| + |
| -- |
| Whether to show documentation on hover. |
| -- |
| [[rust-analyzer.hover.documentation.keywords.enable]]rust-analyzer.hover.documentation.keywords.enable (default: `true`):: |
| + |
| -- |
| Whether to show keyword hover popups. Only applies when |
| `#rust-analyzer.hover.documentation.enable#` is set. |
| -- |
| [[rust-analyzer.hover.links.enable]]rust-analyzer.hover.links.enable (default: `true`):: |
| + |
| -- |
| Use markdown syntax for links on hover. |
| -- |
| [[rust-analyzer.hover.memoryLayout.alignment]]rust-analyzer.hover.memoryLayout.alignment (default: `"hexadecimal"`):: |
| + |
| -- |
| How to render the align information in a memory layout hover. |
| -- |
| [[rust-analyzer.hover.memoryLayout.enable]]rust-analyzer.hover.memoryLayout.enable (default: `true`):: |
| + |
| -- |
| Whether to show memory layout data on hover. |
| -- |
| [[rust-analyzer.hover.memoryLayout.niches]]rust-analyzer.hover.memoryLayout.niches (default: `false`):: |
| + |
| -- |
| How to render the niche information in a memory layout hover. |
| -- |
| [[rust-analyzer.hover.memoryLayout.offset]]rust-analyzer.hover.memoryLayout.offset (default: `"hexadecimal"`):: |
| + |
| -- |
| How to render the offset information in a memory layout hover. |
| -- |
| [[rust-analyzer.hover.memoryLayout.size]]rust-analyzer.hover.memoryLayout.size (default: `"both"`):: |
| + |
| -- |
| How to render the size information in a memory layout hover. |
| -- |
| [[rust-analyzer.hover.show.enumVariants]]rust-analyzer.hover.show.enumVariants (default: `5`):: |
| + |
| -- |
| How many variants of an enum to display when hovering on. Show none if empty. |
| -- |
| [[rust-analyzer.hover.show.fields]]rust-analyzer.hover.show.fields (default: `5`):: |
| + |
| -- |
| How many fields of a struct, variant or union to display when hovering on. Show none if empty. |
| -- |
| [[rust-analyzer.hover.show.traitAssocItems]]rust-analyzer.hover.show.traitAssocItems (default: `null`):: |
| + |
| -- |
| How many associated items of a trait to display when hovering a trait. |
| -- |
| [[rust-analyzer.imports.granularity.enforce]]rust-analyzer.imports.granularity.enforce (default: `false`):: |
| + |
| -- |
| 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. |
| -- |
| [[rust-analyzer.imports.granularity.group]]rust-analyzer.imports.granularity.group (default: `"crate"`):: |
| + |
| -- |
| How imports should be grouped into use statements. |
| -- |
| [[rust-analyzer.imports.group.enable]]rust-analyzer.imports.group.enable (default: `true`):: |
| + |
| -- |
| Group inserted imports by the https://rust-analyzer.github.io/manual.html#auto-import[following order]. Groups are separated by newlines. |
| -- |
| [[rust-analyzer.imports.merge.glob]]rust-analyzer.imports.merge.glob (default: `true`):: |
| + |
| -- |
| Whether to allow import insertion to merge new imports into single path glob imports like `use std::fmt::*;`. |
| -- |
| [[rust-analyzer.imports.preferNoStd]]rust-analyzer.imports.preferNoStd (default: `false`):: |
| + |
| -- |
| Prefer to unconditionally use imports of the core and alloc crate, over the std crate. |
| -- |
| [[rust-analyzer.imports.preferPrelude]]rust-analyzer.imports.preferPrelude (default: `false`):: |
| + |
| -- |
| Whether to prefer import paths containing a `prelude` module. |
| -- |
| [[rust-analyzer.imports.prefix]]rust-analyzer.imports.prefix (default: `"plain"`):: |
| + |
| -- |
| The path structure for newly inserted paths to use. |
| -- |
| [[rust-analyzer.imports.prefixExternPrelude]]rust-analyzer.imports.prefixExternPrelude (default: `false`):: |
| + |
| -- |
| Whether to prefix external (including std, core) crate imports with `::`. e.g. "use ::std::io::Read;". |
| -- |
| [[rust-analyzer.inlayHints.bindingModeHints.enable]]rust-analyzer.inlayHints.bindingModeHints.enable (default: `false`):: |
| + |
| -- |
| Whether to show inlay type hints for binding modes. |
| -- |
| [[rust-analyzer.inlayHints.chainingHints.enable]]rust-analyzer.inlayHints.chainingHints.enable (default: `true`):: |
| + |
| -- |
| Whether to show inlay type hints for method chains. |
| -- |
| [[rust-analyzer.inlayHints.closingBraceHints.enable]]rust-analyzer.inlayHints.closingBraceHints.enable (default: `true`):: |
| + |
| -- |
| Whether to show inlay hints after a closing `}` to indicate what item it belongs to. |
| -- |
| [[rust-analyzer.inlayHints.closingBraceHints.minLines]]rust-analyzer.inlayHints.closingBraceHints.minLines (default: `25`):: |
| + |
| -- |
| Minimum number of lines required before the `}` until the hint is shown (set to 0 or 1 |
| to always show them). |
| -- |
| [[rust-analyzer.inlayHints.closureCaptureHints.enable]]rust-analyzer.inlayHints.closureCaptureHints.enable (default: `false`):: |
| + |
| -- |
| Whether to show inlay hints for closure captures. |
| -- |
| [[rust-analyzer.inlayHints.closureReturnTypeHints.enable]]rust-analyzer.inlayHints.closureReturnTypeHints.enable (default: `"never"`):: |
| + |
| -- |
| Whether to show inlay type hints for return types of closures. |
| -- |
| [[rust-analyzer.inlayHints.closureStyle]]rust-analyzer.inlayHints.closureStyle (default: `"impl_fn"`):: |
| + |
| -- |
| Closure notation in type and chaining inlay hints. |
| -- |
| [[rust-analyzer.inlayHints.discriminantHints.enable]]rust-analyzer.inlayHints.discriminantHints.enable (default: `"never"`):: |
| + |
| -- |
| Whether to show enum variant discriminant hints. |
| -- |
| [[rust-analyzer.inlayHints.expressionAdjustmentHints.enable]]rust-analyzer.inlayHints.expressionAdjustmentHints.enable (default: `"never"`):: |
| + |
| -- |
| Whether to show inlay hints for type adjustments. |
| -- |
| [[rust-analyzer.inlayHints.expressionAdjustmentHints.hideOutsideUnsafe]]rust-analyzer.inlayHints.expressionAdjustmentHints.hideOutsideUnsafe (default: `false`):: |
| + |
| -- |
| Whether to hide inlay hints for type adjustments outside of `unsafe` blocks. |
| -- |
| [[rust-analyzer.inlayHints.expressionAdjustmentHints.mode]]rust-analyzer.inlayHints.expressionAdjustmentHints.mode (default: `"prefix"`):: |
| + |
| -- |
| Whether to show inlay hints as postfix ops (`.*` instead of `*`, etc). |
| -- |
| [[rust-analyzer.inlayHints.genericParameterHints.const.enable]]rust-analyzer.inlayHints.genericParameterHints.const.enable (default: `true`):: |
| + |
| -- |
| Whether to show const generic parameter name inlay hints. |
| -- |
| [[rust-analyzer.inlayHints.genericParameterHints.lifetime.enable]]rust-analyzer.inlayHints.genericParameterHints.lifetime.enable (default: `false`):: |
| + |
| -- |
| Whether to show generic lifetime parameter name inlay hints. |
| -- |
| [[rust-analyzer.inlayHints.genericParameterHints.type.enable]]rust-analyzer.inlayHints.genericParameterHints.type.enable (default: `false`):: |
| + |
| -- |
| Whether to show generic type parameter name inlay hints. |
| -- |
| [[rust-analyzer.inlayHints.implicitDrops.enable]]rust-analyzer.inlayHints.implicitDrops.enable (default: `false`):: |
| + |
| -- |
| Whether to show implicit drop hints. |
| -- |
| [[rust-analyzer.inlayHints.lifetimeElisionHints.enable]]rust-analyzer.inlayHints.lifetimeElisionHints.enable (default: `"never"`):: |
| + |
| -- |
| Whether to show inlay type hints for elided lifetimes in function signatures. |
| -- |
| [[rust-analyzer.inlayHints.lifetimeElisionHints.useParameterNames]]rust-analyzer.inlayHints.lifetimeElisionHints.useParameterNames (default: `false`):: |
| + |
| -- |
| Whether to prefer using parameter names as the name for elided lifetime hints if possible. |
| -- |
| [[rust-analyzer.inlayHints.maxLength]]rust-analyzer.inlayHints.maxLength (default: `25`):: |
| + |
| -- |
| Maximum length for inlay hints. Set to null to have an unlimited length. |
| -- |
| [[rust-analyzer.inlayHints.parameterHints.enable]]rust-analyzer.inlayHints.parameterHints.enable (default: `true`):: |
| + |
| -- |
| Whether to show function parameter name inlay hints at the call |
| site. |
| -- |
| [[rust-analyzer.inlayHints.rangeExclusiveHints.enable]]rust-analyzer.inlayHints.rangeExclusiveHints.enable (default: `false`):: |
| + |
| -- |
| Whether to show exclusive range inlay hints. |
| -- |
| [[rust-analyzer.inlayHints.reborrowHints.enable]]rust-analyzer.inlayHints.reborrowHints.enable (default: `"never"`):: |
| + |
| -- |
| Whether to show inlay hints for compiler inserted reborrows. |
| This setting is deprecated in favor of #rust-analyzer.inlayHints.expressionAdjustmentHints.enable#. |
| -- |
| [[rust-analyzer.inlayHints.renderColons]]rust-analyzer.inlayHints.renderColons (default: `true`):: |
| + |
| -- |
| Whether to render leading colons for type hints, and trailing colons for parameter hints. |
| -- |
| [[rust-analyzer.inlayHints.typeHints.enable]]rust-analyzer.inlayHints.typeHints.enable (default: `true`):: |
| + |
| -- |
| Whether to show inlay type hints for variables. |
| -- |
| [[rust-analyzer.inlayHints.typeHints.hideClosureInitialization]]rust-analyzer.inlayHints.typeHints.hideClosureInitialization (default: `false`):: |
| + |
| -- |
| Whether to hide inlay type hints for `let` statements that initialize to a closure. |
| Only applies to closures with blocks, same as `#rust-analyzer.inlayHints.closureReturnTypeHints.enable#`. |
| -- |
| [[rust-analyzer.inlayHints.typeHints.hideNamedConstructor]]rust-analyzer.inlayHints.typeHints.hideNamedConstructor (default: `false`):: |
| + |
| -- |
| Whether to hide inlay type hints for constructors. |
| -- |
| [[rust-analyzer.interpret.tests]]rust-analyzer.interpret.tests (default: `false`):: |
| + |
| -- |
| Enables the experimental support for interpreting tests. |
| -- |
| [[rust-analyzer.joinLines.joinAssignments]]rust-analyzer.joinLines.joinAssignments (default: `true`):: |
| + |
| -- |
| Join lines merges consecutive declaration and initialization of an assignment. |
| -- |
| [[rust-analyzer.joinLines.joinElseIf]]rust-analyzer.joinLines.joinElseIf (default: `true`):: |
| + |
| -- |
| Join lines inserts else between consecutive ifs. |
| -- |
| [[rust-analyzer.joinLines.removeTrailingComma]]rust-analyzer.joinLines.removeTrailingComma (default: `true`):: |
| + |
| -- |
| Join lines removes trailing commas. |
| -- |
| [[rust-analyzer.joinLines.unwrapTrivialBlock]]rust-analyzer.joinLines.unwrapTrivialBlock (default: `true`):: |
| + |
| -- |
| Join lines unwraps trivial blocks. |
| -- |
| [[rust-analyzer.lens.debug.enable]]rust-analyzer.lens.debug.enable (default: `true`):: |
| + |
| -- |
| Whether to show `Debug` lens. Only applies when |
| `#rust-analyzer.lens.enable#` is set. |
| -- |
| [[rust-analyzer.lens.enable]]rust-analyzer.lens.enable (default: `true`):: |
| + |
| -- |
| Whether to show CodeLens in Rust files. |
| -- |
| [[rust-analyzer.lens.implementations.enable]]rust-analyzer.lens.implementations.enable (default: `true`):: |
| + |
| -- |
| Whether to show `Implementations` lens. Only applies when |
| `#rust-analyzer.lens.enable#` is set. |
| -- |
| [[rust-analyzer.lens.location]]rust-analyzer.lens.location (default: `"above_name"`):: |
| + |
| -- |
| Where to render annotations. |
| -- |
| [[rust-analyzer.lens.references.adt.enable]]rust-analyzer.lens.references.adt.enable (default: `false`):: |
| + |
| -- |
| Whether to show `References` lens for Struct, Enum, and Union. |
| Only applies when `#rust-analyzer.lens.enable#` is set. |
| -- |
| [[rust-analyzer.lens.references.enumVariant.enable]]rust-analyzer.lens.references.enumVariant.enable (default: `false`):: |
| + |
| -- |
| Whether to show `References` lens for Enum Variants. |
| Only applies when `#rust-analyzer.lens.enable#` is set. |
| -- |
| [[rust-analyzer.lens.references.method.enable]]rust-analyzer.lens.references.method.enable (default: `false`):: |
| + |
| -- |
| Whether to show `Method References` lens. Only applies when |
| `#rust-analyzer.lens.enable#` is set. |
| -- |
| [[rust-analyzer.lens.references.trait.enable]]rust-analyzer.lens.references.trait.enable (default: `false`):: |
| + |
| -- |
| Whether to show `References` lens for Trait. |
| Only applies when `#rust-analyzer.lens.enable#` is set. |
| -- |
| [[rust-analyzer.lens.run.enable]]rust-analyzer.lens.run.enable (default: `true`):: |
| + |
| -- |
| Whether to show `Run` lens. Only applies when |
| `#rust-analyzer.lens.enable#` is set. |
| -- |
| [[rust-analyzer.linkedProjects]]rust-analyzer.linkedProjects (default: `[]`):: |
| + |
| -- |
| Disable project auto-discovery in favor of explicitly specified set |
| of projects. |
| |
| Elements must be paths pointing to `Cargo.toml`, |
| `rust-project.json`, `.rs` files (which will be treated as standalone files) or JSON |
| objects in `rust-project.json` format. |
| -- |
| [[rust-analyzer.lru.capacity]]rust-analyzer.lru.capacity (default: `null`):: |
| + |
| -- |
| Number of syntax trees rust-analyzer keeps in memory. Defaults to 128. |
| -- |
| [[rust-analyzer.lru.query.capacities]]rust-analyzer.lru.query.capacities (default: `{}`):: |
| + |
| -- |
| Sets the LRU capacity of the specified queries. |
| -- |
| [[rust-analyzer.notifications.cargoTomlNotFound]]rust-analyzer.notifications.cargoTomlNotFound (default: `true`):: |
| + |
| -- |
| Whether to show `can't find Cargo.toml` error message. |
| -- |
| [[rust-analyzer.numThreads]]rust-analyzer.numThreads (default: `null`):: |
| + |
| -- |
| How many worker threads in the main loop. The default `null` means to pick automatically. |
| -- |
| [[rust-analyzer.procMacro.attributes.enable]]rust-analyzer.procMacro.attributes.enable (default: `true`):: |
| + |
| -- |
| Expand attribute macros. Requires `#rust-analyzer.procMacro.enable#` to be set. |
| -- |
| [[rust-analyzer.procMacro.enable]]rust-analyzer.procMacro.enable (default: `true`):: |
| + |
| -- |
| Enable support for procedural macros, implies `#rust-analyzer.cargo.buildScripts.enable#`. |
| -- |
| [[rust-analyzer.procMacro.ignored]]rust-analyzer.procMacro.ignored (default: `{}`):: |
| + |
| -- |
| These proc-macros will be ignored when trying to expand them. |
| |
| This config takes a map of crate names with the exported proc-macro names to ignore as values. |
| -- |
| [[rust-analyzer.procMacro.server]]rust-analyzer.procMacro.server (default: `null`):: |
| + |
| -- |
| Internal config, path to proc-macro server executable. |
| -- |
| [[rust-analyzer.references.excludeImports]]rust-analyzer.references.excludeImports (default: `false`):: |
| + |
| -- |
| Exclude imports from find-all-references. |
| -- |
| [[rust-analyzer.references.excludeTests]]rust-analyzer.references.excludeTests (default: `false`):: |
| + |
| -- |
| Exclude tests from find-all-references. |
| -- |
| [[rust-analyzer.runnables.command]]rust-analyzer.runnables.command (default: `null`):: |
| + |
| -- |
| Command to be executed instead of 'cargo' for runnables. |
| -- |
| [[rust-analyzer.runnables.extraArgs]]rust-analyzer.runnables.extraArgs (default: `[]`):: |
| + |
| -- |
| Additional arguments to be passed to cargo for runnables such as |
| tests or binaries. For example, it may be `--release`. |
| -- |
| [[rust-analyzer.runnables.extraTestBinaryArgs]]rust-analyzer.runnables.extraTestBinaryArgs:: |
| + |
| -- |
| Default: |
| ---- |
| [ |
| "--show-output" |
| ] |
| ---- |
| Additional arguments to be passed through Cargo to launched tests, benchmarks, or |
| doc-tests. |
| |
| Unless the launched target uses a |
| [custom test harness](https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-harness-field), |
| they will end up being interpreted as options to |
| [`rustc`’s built-in test harness (“libtest”)](https://doc.rust-lang.org/rustc/tests/index.html#cli-arguments). |
| |
| -- |
| [[rust-analyzer.rustc.source]]rust-analyzer.rustc.source (default: `null`):: |
| + |
| -- |
| Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private |
| projects, or "discover" to try to automatically find it if the `rustc-dev` component |
| is installed. |
| |
| Any project which uses rust-analyzer with the rustcPrivate |
| crates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it. |
| |
| This option does not take effect until rust-analyzer is restarted. |
| -- |
| [[rust-analyzer.rustfmt.extraArgs]]rust-analyzer.rustfmt.extraArgs (default: `[]`):: |
| + |
| -- |
| Additional arguments to `rustfmt`. |
| -- |
| [[rust-analyzer.rustfmt.overrideCommand]]rust-analyzer.rustfmt.overrideCommand (default: `null`):: |
| + |
| -- |
| Advanced option, fully override the command rust-analyzer uses for |
| formatting. This should be the equivalent of `rustfmt` here, and |
| not that of `cargo fmt`. The file contents will be passed on the |
| standard input and the formatted result will be read from the |
| standard output. |
| -- |
| [[rust-analyzer.rustfmt.rangeFormatting.enable]]rust-analyzer.rustfmt.rangeFormatting.enable (default: `false`):: |
| + |
| -- |
| Enables the use of rustfmt's unstable range formatting command for the |
| `textDocument/rangeFormatting` request. The rustfmt option is unstable and only |
| available on a nightly build. |
| -- |
| [[rust-analyzer.semanticHighlighting.doc.comment.inject.enable]]rust-analyzer.semanticHighlighting.doc.comment.inject.enable (default: `true`):: |
| + |
| -- |
| Inject additional highlighting into doc comments. |
| |
| When enabled, rust-analyzer will highlight rust source in doc comments as well as intra |
| doc links. |
| -- |
| [[rust-analyzer.semanticHighlighting.nonStandardTokens]]rust-analyzer.semanticHighlighting.nonStandardTokens (default: `true`):: |
| + |
| -- |
| Whether the server is allowed to emit non-standard tokens and modifiers. |
| -- |
| [[rust-analyzer.semanticHighlighting.operator.enable]]rust-analyzer.semanticHighlighting.operator.enable (default: `true`):: |
| + |
| -- |
| Use semantic tokens for operators. |
| |
| When disabled, rust-analyzer will emit semantic tokens only for operator tokens when |
| they are tagged with modifiers. |
| -- |
| [[rust-analyzer.semanticHighlighting.operator.specialization.enable]]rust-analyzer.semanticHighlighting.operator.specialization.enable (default: `false`):: |
| + |
| -- |
| Use specialized semantic tokens for operators. |
| |
| When enabled, rust-analyzer will emit special token types for operator tokens instead |
| of the generic `operator` token type. |
| -- |
| [[rust-analyzer.semanticHighlighting.punctuation.enable]]rust-analyzer.semanticHighlighting.punctuation.enable (default: `false`):: |
| + |
| -- |
| Use semantic tokens for punctuation. |
| |
| When disabled, rust-analyzer will emit semantic tokens only for punctuation tokens when |
| they are tagged with modifiers or have a special role. |
| -- |
| [[rust-analyzer.semanticHighlighting.punctuation.separate.macro.bang]]rust-analyzer.semanticHighlighting.punctuation.separate.macro.bang (default: `false`):: |
| + |
| -- |
| When enabled, rust-analyzer will emit a punctuation semantic token for the `!` of macro |
| calls. |
| -- |
| [[rust-analyzer.semanticHighlighting.punctuation.specialization.enable]]rust-analyzer.semanticHighlighting.punctuation.specialization.enable (default: `false`):: |
| + |
| -- |
| Use specialized semantic tokens for punctuation. |
| |
| When enabled, rust-analyzer will emit special token types for punctuation tokens instead |
| of the generic `punctuation` token type. |
| -- |
| [[rust-analyzer.semanticHighlighting.strings.enable]]rust-analyzer.semanticHighlighting.strings.enable (default: `true`):: |
| + |
| -- |
| Use semantic tokens for strings. |
| |
| In some editors (e.g. vscode) semantic tokens override other highlighting grammars. |
| By disabling semantic tokens for strings, other grammars can be used to highlight |
| their contents. |
| -- |
| [[rust-analyzer.signatureInfo.detail]]rust-analyzer.signatureInfo.detail (default: `"full"`):: |
| + |
| -- |
| Show full signature of the callable. Only shows parameters if disabled. |
| -- |
| [[rust-analyzer.signatureInfo.documentation.enable]]rust-analyzer.signatureInfo.documentation.enable (default: `true`):: |
| + |
| -- |
| Show documentation. |
| -- |
| [[rust-analyzer.typing.autoClosingAngleBrackets.enable]]rust-analyzer.typing.autoClosingAngleBrackets.enable (default: `false`):: |
| + |
| -- |
| Whether to insert closing angle brackets when typing an opening angle bracket of a generic argument list. |
| -- |
| [[rust-analyzer.workspace.discoverConfig]]rust-analyzer.workspace.discoverConfig (default: `null`):: |
| + |
| -- |
| Enables automatic discovery of projects using [`DiscoverWorkspaceConfig::command`]. |
| |
| [`DiscoverWorkspaceConfig`] also requires setting `progress_label` and `files_to_watch`. |
| `progress_label` is used for the title in progress indicators, whereas `files_to_watch` |
| is used to determine which build system-specific files should be watched in order to |
| reload rust-analyzer. |
| |
| Below is an example of a valid configuration: |
| ```json |
| "rust-analyzer.workspace.discoverConfig": { |
| "command": [ |
| "rust-project", |
| "develop-json" |
| ], |
| "progressLabel": "rust-analyzer", |
| "filesToWatch": [ |
| "BUCK" |
| ] |
| } |
| ``` |
| |
| ## On `DiscoverWorkspaceConfig::command` |
| |
| **Warning**: This format is provisional and subject to change. |
| |
| [`DiscoverWorkspaceConfig::command`] *must* return a JSON object |
| corresponding to `DiscoverProjectData::Finished`: |
| |
| ```norun |
| #[derive(Debug, Clone, Deserialize, Serialize)] |
| #[serde(tag = "kind")] |
| #[serde(rename_all = "snake_case")] |
| enum DiscoverProjectData { |
| Finished { buildfile: Utf8PathBuf, project: ProjectJsonData }, |
| Error { error: String, source: Option<String> }, |
| Progress { message: String }, |
| } |
| ``` |
| |
| As JSON, `DiscoverProjectData::Finished` is: |
| |
| ```json |
| { |
| // the internally-tagged representation of the enum. |
| "kind": "finished", |
| // the file used by a non-Cargo build system to define |
| // a package or target. |
| "buildfile": "rust-analyzer/BUILD", |
| // the contents of a rust-project.json, elided for brevity |
| "project": { |
| "sysroot": "foo", |
| "crates": [] |
| } |
| } |
| ``` |
| |
| It is encouraged, but not required, to use the other variants on |
| `DiscoverProjectData` to provide a more polished end-user experience. |
| |
| `DiscoverWorkspaceConfig::command` may *optionally* include an `{arg}`, |
| which will be substituted with the JSON-serialized form of the following |
| enum: |
| |
| ```norun |
| #[derive(PartialEq, Clone, Debug, Serialize)] |
| #[serde(rename_all = "camelCase")] |
| pub enum DiscoverArgument { |
| Path(AbsPathBuf), |
| Buildfile(AbsPathBuf), |
| } |
| ``` |
| |
| The JSON representation of `DiscoverArgument::Path` is: |
| |
| ```json |
| { |
| "path": "src/main.rs" |
| } |
| ``` |
| |
| Similarly, the JSON representation of `DiscoverArgument::Buildfile` is: |
| |
| ``` |
| { |
| "buildfile": "BUILD" |
| } |
| ``` |
| |
| `DiscoverArgument::Path` is used to find and generate a `rust-project.json`, |
| and therefore, a workspace, whereas `DiscoverArgument::buildfile` is used to |
| to update an existing workspace. As a reference for implementors, |
| buck2's `rust-project` will likely be useful: |
| https://github.com/facebook/buck2/tree/main/integrations/rust-project. |
| -- |
| [[rust-analyzer.workspace.symbol.search.kind]]rust-analyzer.workspace.symbol.search.kind (default: `"only_types"`):: |
| + |
| -- |
| Workspace symbol search kind. |
| -- |
| [[rust-analyzer.workspace.symbol.search.limit]]rust-analyzer.workspace.symbol.search.limit (default: `128`):: |
| + |
| -- |
| Limits the number of items returned from a workspace symbol search (Defaults to 128). |
| Some clients like vs-code issue new searches on result filtering and don't require all results to be returned in the initial search. |
| Other clients requires all results upfront and might require a higher limit. |
| -- |
| [[rust-analyzer.workspace.symbol.search.scope]]rust-analyzer.workspace.symbol.search.scope (default: `"workspace"`):: |
| + |
| -- |
| Workspace symbol search scope. |
| -- |
