itsscb/rust-analyzer
1
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer.git synced 2025-09-25 11:17:13 +00:00
Code Issues Packages Projects Releases Wiki Activity
rust-analyzer/editors/code/package.json

3766 lines
161 KiB
JSON
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"name": "rust-analyzer",
"displayName": "rust-analyzer",
"description": "Rust language support for Visual Studio Code",
"private": true,
"icon": "icon.png",
"version": "0.5.0-dev",
"releaseTag": null,
"publisher": "rust-lang",
"type": "commonjs",
"repository": {
"url": "https://github.com/rust-lang/rust-analyzer.git",
"type": "git"
},
"homepage": "https://rust-analyzer.github.io/",
"license": "MIT OR Apache-2.0",
"keywords": [
"rust"
],
"categories": [
"Formatters",
"Programming Languages"
],
"capabilities": {
"untrustedWorkspaces": {
"supported": false,
"description": "rust-analyzer invokes binaries set up by its configuration as well as the Rust toolchain's binaries. A malicious actor could exploit this to run arbitrary code on your machine."
}
},
"engines": {
"vscode": "^1.93.0"
},
"enabledApiProposals": [],
"scripts": {
"vscode:prepublish": "npm run build-base -- --minify",
"package": "vsce package -o rust-analyzer.vsix",
"build-base": "esbuild ./src/main.ts --bundle --outfile=out/main.js --external:vscode --format=cjs --platform=node --target=node20",
"build": "npm run build-base -- --sourcemap",
"watch": "npm run build-base -- --sourcemap --watch",
"format": "node --experimental-strip-types node_modules/prettier/bin/prettier.cjs . --write",
"format:check": "node --experimental-strip-types node_modules/prettier/bin/prettier.cjs . --check",
"lint": "eslint .",
"lint:fix": "npm run lint -- --fix",
"typecheck": "tsc",
"pretest": "npm run typecheck && npm run build",
"test": "node ./out/tests/runTests.js"
},
"dependencies": {
"@hpcc-js/wasm": "^2.22.4",
"anser": "^2.3.2",
"d3": "^7.9.0",
"d3-graphviz": "^5.6.0",
"jiti": "^2.4.2",
"vscode-languageclient": "^9.0.1"
},
"devDependencies": {
"@eslint/js": "^9.21.0",
"@stylistic/eslint-plugin": "^4.1.0",
"@stylistic/eslint-plugin-js": "^4.1.0",
"@tsconfig/strictest": "^2.0.5",
"@types/node": "~22.13.4",
"@types/vscode": "~1.93.0",
"@typescript-eslint/eslint-plugin": "^8.25.0",
"@typescript-eslint/parser": "^8.25.0",
"@vscode/test-electron": "^2.4.1",
"@vscode/vsce": "^3.6.0",
"esbuild": "^0.25.0",
"eslint": "^9.21.0",
"eslint-config-prettier": "^10.0.2",
"eslint-define-config": "^2.1.0",
"ovsx": "0.10.1",
"prettier": "^3.5.2",
"tslib": "^2.8.1",
"typescript": "^5.7.3",
"typescript-eslint": "^8.25.0"
},
"activationEvents": [
"workspaceContains:Cargo.toml",
"workspaceContains:*/Cargo.toml",
"workspaceContains:rust-project.json",
"workspaceContains:*/rust-project.json",
"workspaceContains:.rust-project.json",
"workspaceContains:*/.rust-project.json"
],
"main": "./out/main",
"contributes": {
"taskDefinitions": [
{
"type": "cargo",
"required": [
"command"
],
"properties": {
"label": {
"type": "string"
},
"command": {
"type": "string"
},
"args": {
"type": "array",
"items": {
"type": "string"
}
},
"env": {
"type": "object",
"patternProperties": {
".+": {
"type": "string"
}
}
}
}
}
],
"commands": [
{
"command": "rust-analyzer.viewHir",
"title": "View Hir",
"category": "rust-analyzer (debug command)"
},
{
"command": "rust-analyzer.viewMir",
"title": "View Mir",
"category": "rust-analyzer (debug command)"
},
{
"command": "rust-analyzer.interpretFunction",
"title": "Interpret",
"category": "rust-analyzer (debug command)"
},
{
"command": "rust-analyzer.viewFileText",
"title": "View File Text (as seen by the server)",
"category": "rust-analyzer (debug command)"
},
{
"command": "rust-analyzer.viewItemTree",
"title": "Debug ItemTree",
"category": "rust-analyzer (debug command)"
},
{
"command": "rust-analyzer.memoryUsage",
"title": "Memory Usage (Clears Database)",
"category": "rust-analyzer (debug command)"
},
{
"command": "rust-analyzer.viewCrateGraph",
"title": "View Crate Graph",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.viewFullCrateGraph",
"title": "View Crate Graph (Full)",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.expandMacro",
"title": "Expand macro recursively at caret",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.matchingBrace",
"title": "Find matching brace",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.parentModule",
"title": "Locate parent module",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.childModules",
"title": "Locate child modules",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.joinLines",
"title": "Join lines",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.run",
"title": "Run",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.copyRunCommandLine",
"title": "Copy Run Command Line",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.debug",
"title": "Debug",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.newDebugConfig",
"title": "Generate launch configuration",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.analyzerStatus",
"title": "Status",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.reloadWorkspace",
"title": "Reload workspace",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.rebuildProcMacros",
"title": "Rebuild proc macros and build scripts",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.restartServer",
"title": "Restart server",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.startServer",
"title": "Start server",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.stopServer",
"title": "Stop server",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.onEnter",
"title": "Enhanced enter key",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.ssr",
"title": "Structural Search Replace",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.serverVersion",
"title": "Show RA Version",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.openDocs",
"title": "Open Docs",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.openExternalDocs",
"title": "Open External Docs",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.openCargoToml",
"title": "Open Cargo.toml",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.peekTests",
"title": "Peek Related Tests",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.moveItemUp",
"title": "Move Item Up",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.moveItemDown",
"title": "Move Item Down",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.cancelFlycheck",
"title": "Cancel running flychecks",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.runFlycheck",
"title": "Run flycheck",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.clearFlycheck",
"title": "Clear flycheck diagnostics",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.revealDependency",
"title": "Reveal File",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.syntaxTreeReveal",
"title": "Reveal Syntax Element",
"icon": "$(search)",
"category": "rust-analyzer (syntax tree)"
},
{
"command": "rust-analyzer.syntaxTreeCopy",
"title": "Copy",
"icon": "$(copy)",
"category": "rust-analyzer (syntax tree)"
},
{
"command": "rust-analyzer.syntaxTreeHideWhitespace",
"title": "Hide Whitespace",
"icon": "$(filter)",
"category": "rust-analyzer (syntax tree)"
},
{
"command": "rust-analyzer.syntaxTreeShowWhitespace",
"title": "Show Whitespace",
"icon": "$(filter-filled)",
"category": "rust-analyzer (syntax tree)"
},
{
"command": "rust-analyzer.viewMemoryLayout",
"title": "View Memory Layout",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.toggleCheckOnSave",
"title": "Toggle Check on Save",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.toggleLSPLogs",
"title": "Toggle LSP Logs",
"category": "rust-analyzer"
},
{
"command": "rust-analyzer.openWalkthrough",
"title": "Open Walkthrough",
"category": "rust-analyzer"
}
],
"keybindings": [
{
"command": "rust-analyzer.parentModule",
"key": "ctrl+shift+u",
"when": "editorTextFocus && editorLangId == rust"
},
{
"command": "rust-analyzer.joinLines",
"key": "ctrl+shift+j",
"when": "editorTextFocus && editorLangId == rust"
}
],
"configuration": [
{
"title": "Rust Analyzer"
},
{
"title": "Assist"
},
{
"title": "Cache Priming"
},
{
"title": "Cargo"
},
{
"title": "Cfg"
},
{
"title": "Check"
},
{
"title": "Completion"
},
{
"title": "Debug"
},
{
"title": "Diagnostics"
},
{
"title": "Files"
},
{
"title": "Highlight Related"
},
{
"title": "Hover"
},
{
"title": "Imports"
},
{
"title": "Inlay Hints"
},
{
"title": "Interpret"
},
{
"title": "Join Lines"
},
{
"title": "Lens"
},
{
"title": "Lru"
},
{
"title": "Notifications"
},
{
"title": "Proc Macro"
},
{
"title": "References"
},
{
"title": "Runnables"
},
{
"title": "Rustc"
},
{
"title": "Rustfmt"
},
{
"title": "Semantic Highlighting"
},
{
"title": "Signature Info"
},
{
"title": "Typing"
},
{
"title": "Vfs"
},
{
"title": "Workspace"
},
{
"title": "rust-analyzer",
"properties": {
"rust-analyzer.restartServerOnConfigChange": {
"description": "Restart the server automatically when settings that require a restart are changed.",
"default": false,
"type": "boolean"
},
"rust-analyzer.showUnlinkedFileNotification": {
"description": "Show a notification for unlinked files, prompting the user to add the corresponding Cargo.toml to the linked projects setting.",
"default": true,
"type": "boolean"
},
"rust-analyzer.showRequestFailedErrorNotification": {
"description": "Show error notifications when requests fail.",
"default": true,
"type": "boolean"
},
"rust-analyzer.showDependenciesExplorer": {
"description": "Show Rust Dependencies in the Explorer view.",
"default": true,
"type": "boolean"
},
"rust-analyzer.showSyntaxTree": {
"description": "Show Syntax Tree in the Explorer view.",
"default": false,
"type": "boolean"
},
"rust-analyzer.testExplorer": {
"description": "Show the Test Explorer view.",
"default": false,
"type": "boolean"
},
"rust-analyzer.initializeStopped": {
"markdownDescription": "Do not start rust-analyzer server when the extension is activated.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Runnables",
"properties": {
"rust-analyzer.runnables.extraEnv": {
"anyOf": [
{
"type": "null"
},
{
"type": "array",
"items": {
"type": "object",
"properties": {
"platform": {
"type": [
"null",
"string",
"array"
],
"default": null,
"markdownDescription": "Platform(s) filter like \"win32\" or [\"linux\", \"win32\"]. See [process.platform](https://nodejs.org/api/process.html#processplatform) values."
},
"mask": {
"type": "string",
"description": "Runnable name mask"
},
"env": {
"type": "object",
"description": "Variables in form of { \"key\": \"value\"}"
}
}
}
},
{
"type": "object",
"description": "Variables in form of { \"key\": \"value\"}"
}
],
"default": null,
"markdownDescription": "Environment variables passed to the runnable launched using `Test` or `Debug` lens or `rust-analyzer.run` command."
},
"rust-analyzer.runnables.problemMatcher": {
"type": "array",
"items": {
"type": "string"
},
"default": [
"$rustc"
],
"markdownDescription": "Problem matchers to use for `rust-analyzer.run` command, eg `[\"$rustc\", \"$rust-panic\"]`."
},
"rust-analyzer.runnables.askBeforeUpdateTest": {
"type": "boolean",
"default": true,
"markdownDescription": "Ask before updating the test when running it."
}
}
},
{
"title": "Status Bar",
"properties": {
"rust-analyzer.statusBar.clickAction": {
"type": "string",
"enum": [
"stopServer",
"openLogs"
],
"enumDescriptions": [
"Stop Server",
"Open Logs"
],
"default": "openLogs",
"markdownDescription": "Action to run when clicking the extension status bar item."
},
"rust-analyzer.statusBar.showStatusBar": {
"markdownDescription": "When to show the extension status bar.\n\n`\"always\"` Always show the status bar.\n\n`\"never\"` Never show the status bar.\n\n`{ documentSelector: <DocumentSelector>[] }` Show the status bar if the open file matches any of the given document selectors.\n\nSee [VS Code -- DocumentSelector](https://code.visualstudio.com/api/references/document-selector) for more information.",
"anyOf": [
{
"type": "string",
"enum": [
"always",
"never"
]
},
{
"type": "object",
"properties": {
"documentSelector": {
"type": "array",
"items": {
"type": "object",
"properties": {
"language": {
"type": "string"
},
"notebookType": {
"type": "string"
},
"scheme": {
"type": "string"
},
"pattern": {
"type": "string"
}
}
}
}
}
}
],
"default": {
"documentSelector": [
{
"language": "rust"
},
{
"pattern": "**/Cargo.toml"
},
{
"pattern": "**/Cargo.lock"
},
{
"scheme": "output",
"pattern": "extension-output-rust-lang.rust-analyzer*"
}
]
}
}
}
},
{
"title": "Server",
"properties": {
"rust-analyzer.server.path": {
"type": [
"null",
"string"
],
"scope": "machine-overridable",
"default": null,
"markdownDescription": "Path to rust-analyzer executable (points to bundled binary by default)."
},
"rust-analyzer.server.extraEnv": {
"type": [
"null",
"object"
],
"additionalProperties": {
"type": [
"string",
"number",
"null"
]
},
"default": null,
"markdownDescription": "Extra environment variables that will be passed to the rust-analyzer executable. Useful for passing e.g. `RA_LOG` for debugging."
}
}
},
{
"title": "Trace",
"properties": {
"rust-analyzer.trace.server": {
"type": "string",
"scope": "window",
"enum": [
"off",
"messages",
"verbose"
],
"enumDescriptions": [
"No traces",
"Error only",
"Full log"
],
"default": "off",
"description": "Trace requests to the rust-analyzer (this is usually overly verbose and not recommended for regular users)."
},
"rust-analyzer.trace.extension": {
"description": "Enable logging of VS Code extensions itself.",
"markdownDeprecationMessage": "Log level is now controlled by the [Developer: Set Log Level...](command:workbench.action.setLogLevel) command.You can set the log level for the current session and also the default log level from there. This is also available by clicking the gear icon on the OUTPUT tab when Rust Analyzer Client is visible or by passing the --log rust-lang.rust-analyzer:debug parameter to VS Code.",
"type": "boolean",
"default": false
}
}
},
{
"title": "Debug",
"properties": {
"rust-analyzer.debug.engine": {
"type": "string",
"enum": [
"auto",
"llvm-vs-code-extensions.lldb-dap",
"vadimcn.vscode-lldb",
"ms-vscode.cpptools",
"webfreak.debug"
],
"default": "auto",
"description": "Preferred debug engine.",
"markdownEnumDescriptions": [
"Use the first available extension out of [LLDB DAP](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.lldb-dap), [CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb), [C/C++ for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools), and [Native Debug](https://marketplace.visualstudio.com/items?itemName=webfreak.debug).",
"Use [LLDB DAP](https://marketplace.visualstudio.com/items?itemName=llvm-vs-code-extensions.lldb-dap)",
"Use [CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb)",
"Use [C/C++ for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools)",
"Use [Native Debug](https://marketplace.visualstudio.com/items?itemName=webfreak.debug)"
]
},
"rust-analyzer.debug.sourceFileMap": {
"type": [
"object",
"string"
],
"const": "auto",
"description": "Optional source file mappings passed to the debug engine.",
"default": {
"/rustc/<id>": "${env:USERPROFILE}/.rustup/toolchains/<toolchain-id>/lib/rustlib/src/rust"
}
},
"rust-analyzer.debug.buildBeforeRestart": {
"markdownDescription": "Whether to rebuild the project modules before debugging the same test again",
"type": "boolean",
"default": false
},
"rust-analyzer.debug.engineSettings": {
"type": "object",
"default": {},
"markdownDescription": "Optional settings passed to the debug engine. Example: `{ \"lldb\": { \"terminal\":\"external\"} }`"
}
}
},
{
"title": "Typing",
"properties": {
"rust-analyzer.typing.continueCommentsOnNewline": {
"markdownDescription": "Whether to prefix newlines after comments with the corresponding comment prefix.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Diagnostics",
"properties": {
"rust-analyzer.diagnostics.previewRustcOutput": {
"markdownDescription": "Whether to show the main part of the rendered rustc output of a diagnostic message.",
"default": false,
"type": "boolean"
},
"rust-analyzer.diagnostics.useRustcErrorCode": {
"markdownDescription": "Whether to show diagnostics using the original rustc error code. If this is false, all rustc diagnostics will have the code 'rustc(Click for full compiler diagnostics)'",
"default": false,
"type": "boolean"
}
}
},
{
"title": "$generated-start"
},
{
"title": "Assist",
"properties": {
"rust-analyzer.assist.emitMustUse": {
"markdownDescription": "Insert #[must_use] when generating `as_` methods for enum variants.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Assist",
"properties": {
"rust-analyzer.assist.expressionFillDefault": {
"markdownDescription": "Placeholder expression to use for missing expressions in assists.",
"default": "todo",
"type": "string",
"enum": [
"todo",
"default"
],
"enumDescriptions": [
"Fill missing expressions with the `todo` macro",
"Fill missing expressions with reasonable defaults, `new` or `default` constructors."
]
}
}
},
{
"title": "Assist",
"properties": {
"rust-analyzer.assist.preferSelf": {
"markdownDescription": "Prefer to use `Self` over the type name when inserting a type (e.g. in \"fill match arms\" assist).",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Assist",
"properties": {
"rust-analyzer.assist.termSearch.borrowcheck": {
"markdownDescription": "Enable borrow checking for term search code assists. If set to false, also there will be\nmore suggestions, but some of them may not borrow-check.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Assist",
"properties": {
"rust-analyzer.assist.termSearch.fuel": {
"markdownDescription": "Term search fuel in \"units of work\" for assists (Defaults to 1800).",
"default": 1800,
"type": "integer",
"minimum": 0
}
}
},
{
"title": "Cache Priming",
"properties": {
"rust-analyzer.cachePriming.enable": {
"markdownDescription": "Warm up caches on project load.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Cache Priming",
"properties": {
"rust-analyzer.cachePriming.numThreads": {
"markdownDescription": "How many worker threads to handle priming caches. The default `0` means to pick\nautomatically.",
"default": "physical",
"anyOf": [
{
"type": "number",
"minimum": 0,
"maximum": 255
},
{
"type": "string",
"enum": [
"physical",
"logical"
],
"enumDescriptions": [
"Use the number of physical cores",
"Use the number of logical cores"
]
}
]
}
}
},
{
"title": "Cargo",
"properties": {
"rust-analyzer.cargo.allTargets": {
"markdownDescription": "Pass `--all-targets` to cargo invocation.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Cargo",
"properties": {
"rust-analyzer.cargo.autoreload": {
"markdownDescription": "Automatically refresh project info via `cargo metadata` on\n`Cargo.toml` or `.cargo/config.toml` changes.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Cargo",
"properties": {
"rust-analyzer.cargo.buildScripts.enable": {
"markdownDescription": "Run build scripts (`build.rs`) for more precise code analysis.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Cargo",
"properties": {
"rust-analyzer.cargo.buildScripts.invocationStrategy": {
"markdownDescription": "Specifies the invocation strategy to use when running the build scripts command.\nIf `per_workspace` is set, the command will be executed for each Rust workspace with the\nworkspace as the working directory.\nIf `once` is set, the command will be executed once with the opened project as the\nworking directory.\nThis config only has an effect when `#rust-analyzer.cargo.buildScripts.overrideCommand#`\nis set.",
"default": "per_workspace",
"type": "string",
"enum": [
"per_workspace",
"once"
],
"enumDescriptions": [
"The command will be executed for each Rust workspace with the workspace as the working directory.",
"The command will be executed once with the opened project as the working directory."
]
}
}
},
{
"title": "Cargo",
"properties": {
"rust-analyzer.cargo.buildScripts.overrideCommand": {
"markdownDescription": "Override the command rust-analyzer uses to run build scripts and\nbuild procedural macros. The command is required to output json\nand should therefore include `--message-format=json` or a similar\noption.\n\nIf there are multiple linked projects/workspaces, this command is invoked for\neach of them, with the working directory being the workspace root\n(i.e., the folder containing the `Cargo.toml`). This can be overwritten\nby changing `#rust-analyzer.cargo.buildScripts.invocationStrategy#`.\n\nBy default, a cargo invocation will be constructed for the configured\ntargets and features, with the following base command line:\n\n```bash\ncargo check --quiet --workspace --message-format=json --all-targets --keep-going\n```\n\nNote: The option must be specified as an array of command line arguments, with\nthe first argument being the name of the command to run.",
"default": null,
"type": [
"null",
"array"
],
"items": {
"type": "string"
}
}
}
},
{
"title": "Cargo",
"properties": {
"rust-analyzer.cargo.buildScripts.rebuildOnSave": {
"markdownDescription": "Rerun proc-macros building/build-scripts running when proc-macro\nor build-script sources change and are saved.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Cargo",
"properties": {
"rust-analyzer.cargo.buildScripts.useRustcWrapper": {
"markdownDescription": "Use `RUSTC_WRAPPER=rust-analyzer` when running build scripts to\navoid checking unnecessary things.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Cargo",
"properties": {
"rust-analyzer.cargo.cfgs": {
"markdownDescription": "List of cfg options to enable with the given values.\n\nTo enable a name without a value, use `\"key\"`.\nTo enable a name with a value, use `\"key=value\"`.\nTo disable, prefix the entry with a `!`.",
"default": [
"debug_assertions",
"miri"
],
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"title": "Cargo",
"properties": {
"rust-analyzer.cargo.extraArgs": {
"markdownDescription": "Extra arguments that are passed to every cargo invocation.",
"default": [],
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"title": "Cargo",
"properties": {
"rust-analyzer.cargo.extraEnv": {
"markdownDescription": "Extra environment variables that will be set when running cargo, rustc\nor other commands within the workspace. Useful for setting RUSTFLAGS.",
"default": {},
"type": "object"
}
}
},
{
"title": "Cargo",
"properties": {
"rust-analyzer.cargo.features": {
"markdownDescription": "List of features to activate.\n\nSet this to `\"all\"` to pass `--all-features` to cargo.",
"default": [],
"anyOf": [
{
"type": "string",
"enum": [
"all"
],
"enumDescriptions": [
"Pass `--all-features` to cargo"
]
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
}
},
{
"title": "Cargo",
"properties": {
"rust-analyzer.cargo.noDefaultFeatures": {
"markdownDescription": "Whether to pass `--no-default-features` to cargo.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Cargo",
"properties": {
"rust-analyzer.cargo.noDeps": {
"markdownDescription": "Whether to skip fetching dependencies. If set to \"true\", the analysis is performed\nentirely offline, and Cargo metadata for dependencies is not fetched.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Cargo",
"properties": {
"rust-analyzer.cargo.sysroot": {
"markdownDescription": "Relative path to the sysroot, or \"discover\" to try to automatically find it via\n\"rustc --print sysroot\".\n\nUnsetting this disables sysroot loading.\n\nThis option does not take effect until rust-analyzer is restarted.",
"default": "discover",
"type": [
"null",
"string"
]
}
}
},
{
"title": "Cargo",
"properties": {
"rust-analyzer.cargo.sysrootSrc": {
"markdownDescription": "Relative path to the sysroot library sources. If left unset, this will default to\n`{cargo.sysroot}/lib/rustlib/src/rust/library`.\n\nThis option does not take effect until rust-analyzer is restarted.",
"default": null,
"type": [
"null",
"string"
]
}
}
},
{
"title": "Cargo",
"properties": {
"rust-analyzer.cargo.target": {
"markdownDescription": "Compilation target override (target tuple).",
"default": null,
"type": [
"null",
"string"
]
}
}
},
{
"title": "Cargo",
"properties": {
"rust-analyzer.cargo.targetDir": {
"markdownDescription": "Optional path to a rust-analyzer specific target directory.\nThis prevents rust-analyzer's `cargo check` and initial build-script and proc-macro\nbuilding from locking the `Cargo.lock` at the expense of duplicating build artifacts.\n\nSet to `true` to use a subdirectory of the existing target directory or\nset to a path relative to the workspace to use that path.",
"default": null,
"anyOf": [
{
"type": "null"
},
{
"type": "boolean"
},
{
"type": "string"
}
]
}
}
},
{
"title": "Cfg",
"properties": {
"rust-analyzer.cfg.setTest": {
"markdownDescription": "Set `cfg(test)` for local crates. Defaults to true.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "rust-analyzer",
"properties": {
"rust-analyzer.checkOnSave": {
"markdownDescription": "Run the check command for diagnostics on save.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Check",
"properties": {
"rust-analyzer.check.allTargets": {
"markdownDescription": "Check all targets and tests (`--all-targets`). Defaults to\n`#rust-analyzer.cargo.allTargets#`.",
"default": null,
"type": [
"null",
"boolean"
]
}
}
},
{
"title": "Check",
"properties": {
"rust-analyzer.check.command": {
"markdownDescription": "Cargo command to use for `cargo check`.",
"default": "check",
"type": "string"
}
}
},
{
"title": "Check",
"properties": {
"rust-analyzer.check.extraArgs": {
"markdownDescription": "Extra arguments for `cargo check`.",
"default": [],
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"title": "Check",
"properties": {
"rust-analyzer.check.extraEnv": {
"markdownDescription": "Extra environment variables that will be set when running `cargo check`.\nExtends `#rust-analyzer.cargo.extraEnv#`.",
"default": {},
"type": "object"
}
}
},
{
"title": "Check",
"properties": {
"rust-analyzer.check.features": {
"markdownDescription": "List of features to activate. Defaults to\n`#rust-analyzer.cargo.features#`.\n\nSet to `\"all\"` to pass `--all-features` to Cargo.",
"default": null,
"anyOf": [
{
"type": "string",
"enum": [
"all"
],
"enumDescriptions": [
"Pass `--all-features` to cargo"
]
},
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
]
}
}
},
{
"title": "Check",
"properties": {
"rust-analyzer.check.ignore": {
"markdownDescription": "List of `cargo check` (or other command specified in `check.command`) diagnostics to ignore.\n\nFor example for `cargo check`: `dead_code`, `unused_imports`, `unused_variables`,...",
"default": [],
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
}
},
{
"title": "Check",
"properties": {
"rust-analyzer.check.invocationStrategy": {
"markdownDescription": "Specifies the invocation strategy to use when running the check command.\nIf `per_workspace` is set, the command will be executed for each workspace.\nIf `once` is set, the command will be executed once.\nThis config only has an effect when `#rust-analyzer.check.overrideCommand#`\nis set.",
"default": "per_workspace",
"type": "string",
"enum": [
"per_workspace",
"once"
],
"enumDescriptions": [
"The command will be executed for each Rust workspace with the workspace as the working directory.",
"The command will be executed once with the opened project as the working directory."
]
}
}
},
{
"title": "Check",
"properties": {
"rust-analyzer.check.noDefaultFeatures": {
"markdownDescription": "Whether to pass `--no-default-features` to Cargo. Defaults to\n`#rust-analyzer.cargo.noDefaultFeatures#`.",
"default": null,
"type": [
"null",
"boolean"
]
}
}
},
{
"title": "Check",
"properties": {
"rust-analyzer.check.overrideCommand": {
"markdownDescription": "Override the command rust-analyzer uses instead of `cargo check` for\ndiagnostics on save. The command is required to output json and\nshould therefore include `--message-format=json` or a similar option\n(if your client supports the `colorDiagnosticOutput` experimental\ncapability, you can use `--message-format=json-diagnostic-rendered-ansi`).\n\nIf you're changing this because you're using some tool wrapping\nCargo, you might also want to change\n`#rust-analyzer.cargo.buildScripts.overrideCommand#`.\n\nIf there are multiple linked projects/workspaces, this command is invoked for\neach of them, with the working directory being the workspace root\n(i.e., the folder containing the `Cargo.toml`). This can be overwritten\nby changing `#rust-analyzer.check.invocationStrategy#`.\n\nIf `$saved_file` is part of the command, rust-analyzer will pass\nthe absolute path of the saved file to the provided command. This is\nintended to be used with non-Cargo build systems.\nNote that `$saved_file` is experimental and may be removed in the future.\n\nAn example command would be:\n\n```bash\ncargo check --workspace --message-format=json --all-targets\n```\n\nNote: The option must be specified as an array of command line arguments, with\nthe first argument being the name of the command to run.",
"default": null,
"type": [
"null",
"array"
],
"items": {
"type": "string"
}
}
}
},
{
"title": "Check",
"properties": {
"rust-analyzer.check.targets": {
"markdownDescription": "Check for specific targets. Defaults to `#rust-analyzer.cargo.target#` if empty.\n\nCan be a single target, e.g. `\"x86_64-unknown-linux-gnu\"` or a list of targets, e.g.\n`[\"aarch64-apple-darwin\", \"x86_64-apple-darwin\"]`.\n\nAliased as `\"checkOnSave.targets\"`.",
"default": null,
"anyOf": [
{
"type": "null"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
}
}
},
{
"title": "Check",
"properties": {
"rust-analyzer.check.workspace": {
"markdownDescription": "Whether `--workspace` should be passed to `cargo check`.\nIf false, `-p <package>` will be passed instead if applicable. In case it is not, no\ncheck will be performed.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Completion",
"properties": {
"rust-analyzer.completion.addSemicolonToUnit": {
"markdownDescription": "Automatically add a semicolon when completing unit-returning functions.\n\nIn `match` arms it completes a comma instead.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Completion",
"properties": {
"rust-analyzer.completion.autoAwait.enable": {
"markdownDescription": "Show method calls and field accesses completions with `await` prefixed to them when\ncompleting on a future.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Completion",
"properties": {
"rust-analyzer.completion.autoIter.enable": {
"markdownDescription": "Show method call completions with `iter()` or `into_iter()` prefixed to them when\ncompleting on a type that has them.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Completion",
"properties": {
"rust-analyzer.completion.autoimport.enable": {
"markdownDescription": "Show completions that automatically add imports when completed.\n\nNote that your client must specify the `additionalTextEdits` LSP client capability to\ntruly have this feature enabled.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Completion",
"properties": {
"rust-analyzer.completion.autoimport.exclude": {
"markdownDescription": "A list of full paths to items to exclude from auto-importing completions.\n\nTraits in this list won't have their methods suggested in completions unless the trait\nis in scope.\n\nYou can either specify a string path which defaults to type \"always\" or use the more\nverbose form `{ \"path\": \"path::to::item\", type: \"always\" }`.\n\nFor traits the type \"methods\" can be used to only exclude the methods but not the trait\nitself.\n\nThis setting also inherits `#rust-analyzer.completion.excludeTraits#`.",
"default": [
{
"path": "core::borrow::Borrow",
"type": "methods"
},
{
"path": "core::borrow::BorrowMut",
"type": "methods"
}
],
"type": "array",
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "object",
"properties": {
"path": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"always",
"methods"
],
"enumDescriptions": [
"Do not show this item or its methods (if it is a trait) in auto-import completions.",
"Do not show this traits methods in auto-import completions."
]
}
}
}
]
}
}
}
},
{
"title": "Completion",
"properties": {
"rust-analyzer.completion.autoself.enable": {
"markdownDescription": "Show method calls and field access completions with `self` prefixed to them when\ninside a method.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Completion",
"properties": {
"rust-analyzer.completion.callable.snippets": {
"markdownDescription": "Add parenthesis and argument snippets when completing function.",
"default": "fill_arguments",
"type": "string",
"enum": [
"fill_arguments",
"add_parentheses",
"none"
],
"enumDescriptions": [
"Add call parentheses and pre-fill arguments.",
"Add call parentheses.",
"Do no snippet completions for callables."
]
}
}
},
{
"title": "Completion",
"properties": {
"rust-analyzer.completion.excludeTraits": {
"markdownDescription": "A list of full paths to traits whose methods to exclude from completion.\n\nMethods from these traits won't be completed, even if the trait is in scope. However,\nthey will still be suggested on expressions whose type is `dyn Trait`, `impl Trait` or\n`T where T: Trait`.\n\nNote that the trait themselves can still be completed.",
"default": [],
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"title": "Completion",
"properties": {
"rust-analyzer.completion.fullFunctionSignatures.enable": {
"markdownDescription": "Show full function / method signatures in completion docs.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Completion",
"properties": {
"rust-analyzer.completion.hideDeprecated": {
"markdownDescription": "Omit deprecated items from completions. By default they are marked as deprecated but not\nhidden.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Completion",
"properties": {
"rust-analyzer.completion.limit": {
"markdownDescription": "Maximum number of completions to return. If `None`, the limit is infinite.",
"default": null,
"type": [
"null",
"integer"
],
"minimum": 0
}
}
},
{
"title": "Completion",
"properties": {
"rust-analyzer.completion.postfix.enable": {
"markdownDescription": "Show postfix snippets like `dbg`, `if`, `not`, etc.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Completion",
"properties": {
"rust-analyzer.completion.privateEditable.enable": {
"markdownDescription": "Show completions of private items and fields that are defined in the current workspace\neven if they are not visible at the current position.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Completion",
"properties": {
"rust-analyzer.completion.snippets.custom": {
"markdownDescription": "Custom completion snippets.",
"default": {
"Ok": {
"postfix": "ok",
"body": "Ok(${receiver})",
"description": "Wrap the expression in a `Result::Ok`",
"scope": "expr"
},
"Box::pin": {
"postfix": "pinbox",
"body": "Box::pin(${receiver})",
"requires": "std::boxed::Box",
"description": "Put the expression into a pinned `Box`",
"scope": "expr"
},
"Arc::new": {
"postfix": "arc",
"body": "Arc::new(${receiver})",
"requires": "std::sync::Arc",
"description": "Put the expression into an `Arc`",
"scope": "expr"
},
"Some": {
"postfix": "some",
"body": "Some(${receiver})",
"description": "Wrap the expression in an `Option::Some`",
"scope": "expr"
},
"Err": {
"postfix": "err",
"body": "Err(${receiver})",
"description": "Wrap the expression in a `Result::Err`",
"scope": "expr"
},
"Rc::new": {
"postfix": "rc",
"body": "Rc::new(${receiver})",
"requires": "std::rc::Rc",
"description": "Put the expression into an `Rc`",
"scope": "expr"
}
},
"type": "object"
}
}
},
{
"title": "Completion",
"properties": {
"rust-analyzer.completion.termSearch.enable": {
"markdownDescription": "Enable term search based snippets like `Some(foo.bar().baz())`.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Completion",
"properties": {
"rust-analyzer.completion.termSearch.fuel": {
"markdownDescription": "Term search fuel in \"units of work\" for autocompletion (Defaults to 1000).",
"default": 1000,
"type": "integer",
"minimum": 0
}
}
},
{
"title": "Diagnostics",
"properties": {
"rust-analyzer.diagnostics.disabled": {
"markdownDescription": "List of rust-analyzer diagnostics to disable.",
"default": [],
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
}
},
{
"title": "Diagnostics",
"properties": {
"rust-analyzer.diagnostics.enable": {
"markdownDescription": "Show native rust-analyzer diagnostics.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Diagnostics",
"properties": {
"rust-analyzer.diagnostics.experimental.enable": {
"markdownDescription": "Show experimental rust-analyzer diagnostics that might have more false positives than\nusual.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Diagnostics",
"properties": {
"rust-analyzer.diagnostics.remapPrefix": {
"markdownDescription": "Map of prefixes to be substituted when parsing diagnostic file paths. This should be the\nreverse mapping of what is passed to `rustc` as `--remap-path-prefix`.",
"default": {},
"type": "object"
}
}
},
{
"title": "Diagnostics",
"properties": {
"rust-analyzer.diagnostics.styleLints.enable": {
"markdownDescription": "Run additional style lints.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Diagnostics",
"properties": {
"rust-analyzer.diagnostics.warningsAsHint": {
"markdownDescription": "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\nin the `Problems Panel`.",
"default": [],
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"title": "Diagnostics",
"properties": {
"rust-analyzer.diagnostics.warningsAsInfo": {
"markdownDescription": "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\nthe `Problems Panel`.",
"default": [],
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"title": "Document",
"properties": {
"rust-analyzer.document.symbol.search.excludeLocals": {
"markdownDescription": "Exclude all locals from document symbol search.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Files",
"properties": {
"rust-analyzer.files.exclude": {
"markdownDescription": "List of files to ignore\n\nThese paths (file/directories) will be ignored by rust-analyzer. They are relative to\nthe workspace root, and globs are not supported. You may also need to add the folders to\nCode's `files.watcherExclude`.",
"default": [],
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"title": "Files",
"properties": {
"rust-analyzer.files.watcher": {
"markdownDescription": "Controls file watching implementation.",
"default": "client",
"type": "string",
"enum": [
"client",
"server"
],
"enumDescriptions": [
"Use the client (editor) to watch files for changes",
"Use server-side file watching"
]
}
}
},
{
"title": "Highlight Related",
"properties": {
"rust-analyzer.highlightRelated.branchExitPoints.enable": {
"markdownDescription": "Highlight related return values while the cursor is on any `match`, `if`, or match arm\narrow (`=>`).",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Highlight Related",
"properties": {
"rust-analyzer.highlightRelated.breakPoints.enable": {
"markdownDescription": "Highlight related references while the cursor is on `break`, `loop`, `while`, or `for`\nkeywords.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Highlight Related",
"properties": {
"rust-analyzer.highlightRelated.closureCaptures.enable": {
"markdownDescription": "Highlight all captures of a closure while the cursor is on the `|` or move keyword of a closure.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Highlight Related",
"properties": {
"rust-analyzer.highlightRelated.exitPoints.enable": {
"markdownDescription": "Highlight all exit points while the cursor is on any `return`, `?`, `fn`, or return type\narrow (`->`).",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Highlight Related",
"properties": {
"rust-analyzer.highlightRelated.references.enable": {
"markdownDescription": "Highlight related references while the cursor is on any identifier.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Highlight Related",
"properties": {
"rust-analyzer.highlightRelated.yieldPoints.enable": {
"markdownDescription": "Highlight all break points for a loop or block context while the cursor is on any\n`async` or `await` keywords.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.actions.debug.enable": {
"markdownDescription": "Show `Debug` action. Only applies when `#rust-analyzer.hover.actions.enable#` is set.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.actions.enable": {
"markdownDescription": "Show HoverActions in Rust files.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.actions.gotoTypeDef.enable": {
"markdownDescription": "Show `Go to Type Definition` action. Only applies when\n`#rust-analyzer.hover.actions.enable#` is set.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.actions.implementations.enable": {
"markdownDescription": "Show `Implementations` action. Only applies when `#rust-analyzer.hover.actions.enable#`\nis set.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.actions.references.enable": {
"markdownDescription": "Show `References` action. Only applies when `#rust-analyzer.hover.actions.enable#` is\nset.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.actions.run.enable": {
"markdownDescription": "Show `Run` action. Only applies when `#rust-analyzer.hover.actions.enable#` is set.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.actions.updateTest.enable": {
"markdownDescription": "Show `Update Test` action. Only applies when `#rust-analyzer.hover.actions.enable#` and\n`#rust-analyzer.hover.actions.run.enable#` are set.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.documentation.enable": {
"markdownDescription": "Show documentation on hover.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.documentation.keywords.enable": {
"markdownDescription": "Show keyword hover popups. Only applies when\n`#rust-analyzer.hover.documentation.enable#` is set.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.dropGlue.enable": {
"markdownDescription": "Show drop glue information on hover.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.links.enable": {
"markdownDescription": "Use markdown syntax for links on hover.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.maxSubstitutionLength": {
"markdownDescription": "Show what types are used as generic arguments in calls etc. on hover, and limit the max\nlength to show such types, beyond which they will be shown with ellipsis.\n\nThis can take three values: `null` means \"unlimited\", the string `\"hide\"` means to not\nshow generic substitutions at all, and a number means to limit them to X characters.\n\nThe default is 20 characters.",
"default": 20,
"anyOf": [
{
"type": "null"
},
{
"type": "string",
"enum": [
"hide"
]
},
{
"type": "integer"
}
]
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.memoryLayout.alignment": {
"markdownDescription": "How to render the align information in a memory layout hover.",
"default": "hexadecimal",
"anyOf": [
{
"type": "null"
},
{
"type": "string",
"enum": [
"both",
"decimal",
"hexadecimal"
],
"enumDescriptions": [
"Render as 12 (0xC)",
"Render as 12",
"Render as 0xC"
]
}
]
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.memoryLayout.enable": {
"markdownDescription": "Show memory layout data on hover.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.memoryLayout.niches": {
"markdownDescription": "How to render the niche information in a memory layout hover.",
"default": false,
"type": [
"null",
"boolean"
]
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.memoryLayout.offset": {
"markdownDescription": "How to render the offset information in a memory layout hover.",
"default": "hexadecimal",
"anyOf": [
{
"type": "null"
},
{
"type": "string",
"enum": [
"both",
"decimal",
"hexadecimal"
],
"enumDescriptions": [
"Render as 12 (0xC)",
"Render as 12",
"Render as 0xC"
]
}
]
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.memoryLayout.padding": {
"markdownDescription": "How to render the padding information in a memory layout hover.",
"default": null,
"anyOf": [
{
"type": "null"
},
{
"type": "string",
"enum": [
"both",
"decimal",
"hexadecimal"
],
"enumDescriptions": [
"Render as 12 (0xC)",
"Render as 12",
"Render as 0xC"
]
}
]
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.memoryLayout.size": {
"markdownDescription": "How to render the size information in a memory layout hover.",
"default": "both",
"anyOf": [
{
"type": "null"
},
{
"type": "string",
"enum": [
"both",
"decimal",
"hexadecimal"
],
"enumDescriptions": [
"Render as 12 (0xC)",
"Render as 12",
"Render as 0xC"
]
}
]
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.show.enumVariants": {
"markdownDescription": "How many variants of an enum to display when hovering on. Show none if empty.",
"default": 5,
"type": [
"null",
"integer"
],
"minimum": 0
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.show.fields": {
"markdownDescription": "How many fields of a struct, variant or union to display when hovering on. Show none if\nempty.",
"default": 5,
"type": [
"null",
"integer"
],
"minimum": 0
}
}
},
{
"title": "Hover",
"properties": {
"rust-analyzer.hover.show.traitAssocItems": {
"markdownDescription": "How many associated items of a trait to display when hovering a trait.",
"default": null,
"type": [
"null",
"integer"
],
"minimum": 0
}
}
},
{
"title": "Imports",
"properties": {
"rust-analyzer.imports.granularity.enforce": {
"markdownDescription": "Enforce the import granularity setting for all files. If set to false rust-analyzer will\ntry to keep import styles consistent per file.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Imports",
"properties": {
"rust-analyzer.imports.granularity.group": {
"markdownDescription": "How imports should be grouped into use statements.",
"default": "crate",
"type": "string",
"enum": [
"preserve",
"crate",
"module",
"item",
"one"
],
"enumDescriptions": [
"Do not change the granularity of any imports and preserve the original structure written by the developer.",
"Merge imports from the same crate into a single use statement. Conversely, imports from different crates are split into separate statements.",
"Merge imports from the same module into a single use statement. Conversely, imports from different modules are split into separate statements.",
"Flatten imports so that each has its own use statement.",
"Merge all imports into a single use statement as long as they have the same visibility and attributes."
]
}
}
},
{
"title": "Imports",
"properties": {
"rust-analyzer.imports.group.enable": {
"markdownDescription": "Group inserted imports by the [following\norder](https://rust-analyzer.github.io/book/features.html#auto-import). Groups are\nseparated by newlines.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Imports",
"properties": {
"rust-analyzer.imports.merge.glob": {
"markdownDescription": "Allow import insertion to merge new imports into single path glob imports like `use\nstd::fmt::*;`.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Imports",
"properties": {
"rust-analyzer.imports.preferNoStd": {
"markdownDescription": "Prefer to unconditionally use imports of the core and alloc crate, over the std crate.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Imports",
"properties": {
"rust-analyzer.imports.preferPrelude": {
"markdownDescription": "Prefer import paths containing a `prelude` module.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Imports",
"properties": {
"rust-analyzer.imports.prefix": {
"markdownDescription": "The path structure for newly inserted paths to use.",
"default": "crate",
"type": "string",
"enum": [
"plain",
"self",
"crate"
],
"enumDescriptions": [
"Insert import paths relative to the current module, using up to one `super` prefix if the parent module contains the requested item.",
"Insert import paths relative to the current module, using up to one `super` prefix if the parent module contains the requested item. Prefixes `self` in front of the path if it starts with a module.",
"Force import paths to be absolute by always starting them with `crate` or the extern crate name they come from."
]
}
}
},
{
"title": "Imports",
"properties": {
"rust-analyzer.imports.prefixExternPrelude": {
"markdownDescription": "Prefix external (including std, core) crate imports with `::`.\n\nE.g. `use ::std::io::Read;`.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.bindingModeHints.enable": {
"markdownDescription": "Show inlay type hints for binding modes.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.chainingHints.enable": {
"markdownDescription": "Show inlay type hints for method chains.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.closingBraceHints.enable": {
"markdownDescription": "Show inlay hints after a closing `}` to indicate what item it belongs to.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.closingBraceHints.minLines": {
"markdownDescription": "Minimum number of lines required before the `}` until the hint is shown (set to 0 or 1\nto always show them).",
"default": 25,
"type": "integer",
"minimum": 0
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.closureCaptureHints.enable": {
"markdownDescription": "Show inlay hints for closure captures.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.closureReturnTypeHints.enable": {
"markdownDescription": "Show inlay type hints for return types of closures.",
"default": "never",
"type": "string",
"enum": [
"always",
"never",
"with_block"
],
"enumDescriptions": [
"Always show type hints for return types of closures.",
"Never show type hints for return types of closures.",
"Only show type hints for return types of closures with blocks."
]
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.closureStyle": {
"markdownDescription": "Closure notation in type and chaining inlay hints.",
"default": "impl_fn",
"type": "string",
"enum": [
"impl_fn",
"rust_analyzer",
"with_id",
"hide"
],
"enumDescriptions": [
"`impl_fn`: `impl FnMut(i32, u64) -> i8`",
"`rust_analyzer`: `|i32, u64| -> i8`",
"`with_id`: `{closure#14352}`, where that id is the unique number of the closure in r-a internals",
"`hide`: Shows `...` for every closure type"
]
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.discriminantHints.enable": {
"markdownDescription": "Show enum variant discriminant hints.",
"default": "never",
"type": "string",
"enum": [
"always",
"never",
"fieldless"
],
"enumDescriptions": [
"Always show all discriminant hints.",
"Never show discriminant hints.",
"Only show discriminant hints on fieldless enum variants."
]
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.expressionAdjustmentHints.disableReborrows": {
"markdownDescription": "Disable reborrows in expression adjustments inlay hints.\n\nReborrows are a pair of a builtin deref then borrow, i.e. `&*`. They are inserted by the compiler but are mostly useless to the programmer.\n\nNote: if the deref is not builtin (an overloaded deref), or the borrow is `&raw const`/`&raw mut`, they are not removed.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.expressionAdjustmentHints.enable": {
"markdownDescription": "Show inlay hints for type adjustments.",
"default": "never",
"type": "string",
"enum": [
"always",
"never",
"reborrow"
],
"enumDescriptions": [
"Always show all adjustment hints.",
"Never show adjustment hints.",
"Only show auto borrow and dereference adjustment hints."
]
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.expressionAdjustmentHints.hideOutsideUnsafe": {
"markdownDescription": "Hide inlay hints for type adjustments outside of `unsafe` blocks.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.expressionAdjustmentHints.mode": {
"markdownDescription": "Show inlay hints as postfix ops (`.*` instead of `*`, etc).",
"default": "prefix",
"type": "string",
"enum": [
"prefix",
"postfix",
"prefer_prefix",
"prefer_postfix"
],
"enumDescriptions": [
"Always show adjustment hints as prefix (`*expr`).",
"Always show adjustment hints as postfix (`expr.*`).",
"Show prefix or postfix depending on which uses less parenthesis, preferring prefix.",
"Show prefix or postfix depending on which uses less parenthesis, preferring postfix."
]
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.genericParameterHints.const.enable": {
"markdownDescription": "Show const generic parameter name inlay hints.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.genericParameterHints.lifetime.enable": {
"markdownDescription": "Show generic lifetime parameter name inlay hints.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.genericParameterHints.type.enable": {
"markdownDescription": "Show generic type parameter name inlay hints.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.implicitDrops.enable": {
"markdownDescription": "Show implicit drop hints.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.implicitSizedBoundHints.enable": {
"markdownDescription": "Show inlay hints for the implied type parameter `Sized` bound.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.lifetimeElisionHints.enable": {
"markdownDescription": "Show inlay type hints for elided lifetimes in function signatures.",
"default": "never",
"type": "string",
"enum": [
"always",
"never",
"skip_trivial"
],
"enumDescriptions": [
"Always show lifetime elision hints.",
"Never show lifetime elision hints.",
"Only show lifetime elision hints if a return type is involved."
]
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.lifetimeElisionHints.useParameterNames": {
"markdownDescription": "Prefer using parameter names as the name for elided lifetime hints if possible.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.maxLength": {
"markdownDescription": "Maximum length for inlay hints. Set to null to have an unlimited length.\n\n**Note:** This is mostly a hint, and we don't guarantee to strictly follow the limit.",
"default": 25,
"type": [
"null",
"integer"
],
"minimum": 0
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.parameterHints.enable": {
"markdownDescription": "Show function parameter name inlay hints at the call site.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.rangeExclusiveHints.enable": {
"markdownDescription": "Show exclusive range inlay hints.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.reborrowHints.enable": {
"markdownDescription": "Show inlay hints for compiler inserted reborrows.\n\nThis setting is deprecated in favor of\n#rust-analyzer.inlayHints.expressionAdjustmentHints.enable#.",
"default": "never",
"type": "string",
"enum": [
"always",
"never",
"mutable"
],
"enumDescriptions": [
"Always show reborrow hints.",
"Never show reborrow hints.",
"Only show mutable reborrow hints."
]
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.renderColons": {
"markdownDescription": "Whether to render leading colons for type hints, and trailing colons for parameter hints.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.typeHints.enable": {
"markdownDescription": "Show inlay type hints for variables.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.typeHints.hideClosureInitialization": {
"markdownDescription": "Hide inlay type hints for `let` statements that initialize to a closure.\n\nOnly applies to closures with blocks, same as\n`#rust-analyzer.inlayHints.closureReturnTypeHints.enable#`.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.typeHints.hideClosureParameter": {
"markdownDescription": "Hide inlay parameter type hints for closures.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Inlay Hints",
"properties": {
"rust-analyzer.inlayHints.typeHints.hideNamedConstructor": {
"markdownDescription": "Hide inlay type hints for constructors.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Interpret",
"properties": {
"rust-analyzer.interpret.tests": {
"markdownDescription": "Enable the experimental support for interpreting tests.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Join Lines",
"properties": {
"rust-analyzer.joinLines.joinAssignments": {
"markdownDescription": "Join lines merges consecutive declaration and initialization of an assignment.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Join Lines",
"properties": {
"rust-analyzer.joinLines.joinElseIf": {
"markdownDescription": "Join lines inserts else between consecutive ifs.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Join Lines",
"properties": {
"rust-analyzer.joinLines.removeTrailingComma": {
"markdownDescription": "Join lines removes trailing commas.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Join Lines",
"properties": {
"rust-analyzer.joinLines.unwrapTrivialBlock": {
"markdownDescription": "Join lines unwraps trivial blocks.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Lens",
"properties": {
"rust-analyzer.lens.debug.enable": {
"markdownDescription": "Show `Debug` lens. Only applies when `#rust-analyzer.lens.enable#` is set.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Lens",
"properties": {
"rust-analyzer.lens.enable": {
"markdownDescription": "Show CodeLens in Rust files.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Lens",
"properties": {
"rust-analyzer.lens.implementations.enable": {
"markdownDescription": "Show `Implementations` lens. Only applies when `#rust-analyzer.lens.enable#` is set.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Lens",
"properties": {
"rust-analyzer.lens.location": {
"markdownDescription": "Where to render annotations.",
"default": "above_name",
"type": "string",
"enum": [
"above_name",
"above_whole_item"
],
"enumDescriptions": [
"Render annotations above the name of the item.",
"Render annotations above the whole item, including documentation comments and attributes."
]
}
}
},
{
"title": "Lens",
"properties": {
"rust-analyzer.lens.references.adt.enable": {
"markdownDescription": "Show `References` lens for Struct, Enum, and Union. Only applies when\n`#rust-analyzer.lens.enable#` is set.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Lens",
"properties": {
"rust-analyzer.lens.references.enumVariant.enable": {
"markdownDescription": "Show `References` lens for Enum Variants. Only applies when\n`#rust-analyzer.lens.enable#` is set.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Lens",
"properties": {
"rust-analyzer.lens.references.method.enable": {
"markdownDescription": "Show `Method References` lens. Only applies when `#rust-analyzer.lens.enable#` is set.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Lens",
"properties": {
"rust-analyzer.lens.references.trait.enable": {
"markdownDescription": "Show `References` lens for Trait. Only applies when `#rust-analyzer.lens.enable#` is\nset.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Lens",
"properties": {
"rust-analyzer.lens.run.enable": {
"markdownDescription": "Show `Run` lens. Only applies when `#rust-analyzer.lens.enable#` is set.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Lens",
"properties": {
"rust-analyzer.lens.updateTest.enable": {
"markdownDescription": "Show `Update Test` lens. Only applies when `#rust-analyzer.lens.enable#` and\n`#rust-analyzer.lens.run.enable#` are set.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "rust-analyzer",
"properties": {
"rust-analyzer.linkedProjects": {
"markdownDescription": "Disable project auto-discovery in favor of explicitly specified set of projects.\n\nElements must be paths pointing to `Cargo.toml`, `rust-project.json`, `.rs` files (which\nwill be treated as standalone files) or JSON objects in `rust-project.json` format.",
"default": [],
"type": "array",
"items": {
"type": [
"string",
"object"
]
}
}
}
},
{
"title": "Lru",
"properties": {
"rust-analyzer.lru.capacity": {
"markdownDescription": "Number of syntax trees rust-analyzer keeps in memory. Defaults to 128.",
"default": null,
"type": [
"null",
"integer"
],
"minimum": 0,
"maximum": 65535
}
}
},
{
"title": "Lru",
"properties": {
"rust-analyzer.lru.query.capacities": {
"markdownDescription": "The LRU capacity of the specified queries.",
"default": {},
"type": "object"
}
}
},
{
"title": "Notifications",
"properties": {
"rust-analyzer.notifications.cargoTomlNotFound": {
"markdownDescription": "Show `can't find Cargo.toml` error message.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "rust-analyzer",
"properties": {
"rust-analyzer.numThreads": {
"markdownDescription": "The number of worker threads in the main loop. The default `null` means to pick\nautomatically.",
"default": null,
"anyOf": [
{
"type": "null"
},
{
"type": "number",
"minimum": 0,
"maximum": 255
},
{
"type": "string",
"enum": [
"physical",
"logical"
],
"enumDescriptions": [
"Use the number of physical cores",
"Use the number of logical cores"
]
}
]
}
}
},
{
"title": "Proc Macro",
"properties": {
"rust-analyzer.procMacro.attributes.enable": {
"markdownDescription": "Expand attribute macros. Requires `#rust-analyzer.procMacro.enable#` to be set.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Proc Macro",
"properties": {
"rust-analyzer.procMacro.enable": {
"markdownDescription": "Enable support for procedural macros, implies `#rust-analyzer.cargo.buildScripts.enable#`.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Proc Macro",
"properties": {
"rust-analyzer.procMacro.ignored": {
"markdownDescription": "These proc-macros will be ignored when trying to expand them.\n\nThis config takes a map of crate names with the exported proc-macro names to ignore as values.",
"default": {},
"type": "object"
}
}
},
{
"title": "Proc Macro",
"properties": {
"rust-analyzer.procMacro.server": {
"markdownDescription": "Internal config, path to proc-macro server executable.",
"default": null,
"type": [
"null",
"string"
]
}
}
},
{
"title": "References",
"properties": {
"rust-analyzer.references.excludeImports": {
"markdownDescription": "Exclude imports from find-all-references.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "References",
"properties": {
"rust-analyzer.references.excludeTests": {
"markdownDescription": "Exclude tests from find-all-references and call-hierarchy.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Runnables",
"properties": {
"rust-analyzer.runnables.command": {
"markdownDescription": "Command to be executed instead of 'cargo' for runnables.",
"default": null,
"type": [
"null",
"string"
]
}
}
},
{
"title": "Runnables",
"properties": {
"rust-analyzer.runnables.extraArgs": {
"markdownDescription": "Additional arguments to be passed to cargo for runnables such as\ntests or binaries. For example, it may be `--release`.",
"default": [],
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"title": "Runnables",
"properties": {
"rust-analyzer.runnables.extraTestBinaryArgs": {
"markdownDescription": "Additional arguments to be passed through Cargo to launched tests, benchmarks, or\ndoc-tests.\n\nUnless the launched target uses a\n[custom test harness](https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-harness-field),\nthey will end up being interpreted as options to\n[`rustc`’s built-in test harness (“libtest”)](https://doc.rust-lang.org/rustc/tests/index.html#cli-arguments).",
"default": [
"--show-output"
],
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"title": "Rustc",
"properties": {
"rust-analyzer.rustc.source": {
"markdownDescription": "Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private\nprojects, or \"discover\" to try to automatically find it if the `rustc-dev` component\nis installed.\n\nAny project which uses rust-analyzer with the rustcPrivate\ncrates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it.\n\nThis option does not take effect until rust-analyzer is restarted.",
"default": null,
"type": [
"null",
"string"
]
}
}
},
{
"title": "Rustfmt",
"properties": {
"rust-analyzer.rustfmt.extraArgs": {
"markdownDescription": "Additional arguments to `rustfmt`.",
"default": [],
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"title": "Rustfmt",
"properties": {
"rust-analyzer.rustfmt.overrideCommand": {
"markdownDescription": "Advanced option, fully override the command rust-analyzer uses for\nformatting. This should be the equivalent of `rustfmt` here, and\nnot that of `cargo fmt`. The file contents will be passed on the\nstandard input and the formatted result will be read from the\nstandard output.\n\nNote: The option must be specified as an array of command line arguments, with\nthe first argument being the name of the command to run.",
"default": null,
"type": [
"null",
"array"
],
"items": {
"type": "string"
}
}
}
},
{
"title": "Rustfmt",
"properties": {
"rust-analyzer.rustfmt.rangeFormatting.enable": {
"markdownDescription": "Enables the use of rustfmt's unstable range formatting command for the\n`textDocument/rangeFormatting` request. The rustfmt option is unstable and only\navailable on a nightly build.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Semantic Highlighting",
"properties": {
"rust-analyzer.semanticHighlighting.comments.enable": {
"markdownDescription": "Use semantic tokens for comments.\n\nIn some editors (e.g. vscode) semantic tokens override other highlighting grammars.\nBy disabling semantic tokens for comments, other grammars can be used to highlight\ntheir contents.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Semantic Highlighting",
"properties": {
"rust-analyzer.semanticHighlighting.doc.comment.inject.enable": {
"markdownDescription": "Inject additional highlighting into doc comments.\n\nWhen enabled, rust-analyzer will highlight rust source in doc comments as well as intra\ndoc links.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Semantic Highlighting",
"properties": {
"rust-analyzer.semanticHighlighting.nonStandardTokens": {
"markdownDescription": "Emit non-standard tokens and modifiers\n\nWhen enabled, rust-analyzer will emit tokens and modifiers that are not part of the\nstandard set of semantic tokens.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Semantic Highlighting",
"properties": {
"rust-analyzer.semanticHighlighting.operator.enable": {
"markdownDescription": "Use semantic tokens for operators.\n\nWhen disabled, rust-analyzer will emit semantic tokens only for operator tokens when\nthey are tagged with modifiers.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Semantic Highlighting",
"properties": {
"rust-analyzer.semanticHighlighting.operator.specialization.enable": {
"markdownDescription": "Use specialized semantic tokens for operators.\n\nWhen enabled, rust-analyzer will emit special token types for operator tokens instead\nof the generic `operator` token type.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Semantic Highlighting",
"properties": {
"rust-analyzer.semanticHighlighting.punctuation.enable": {
"markdownDescription": "Use semantic tokens for punctuation.\n\nWhen disabled, rust-analyzer will emit semantic tokens only for punctuation tokens when\nthey are tagged with modifiers or have a special role.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Semantic Highlighting",
"properties": {
"rust-analyzer.semanticHighlighting.punctuation.separate.macro.bang": {
"markdownDescription": "When enabled, rust-analyzer will emit a punctuation semantic token for the `!` of macro\ncalls.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Semantic Highlighting",
"properties": {
"rust-analyzer.semanticHighlighting.punctuation.specialization.enable": {
"markdownDescription": "Use specialized semantic tokens for punctuation.\n\nWhen enabled, rust-analyzer will emit special token types for punctuation tokens instead\nof the generic `punctuation` token type.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Semantic Highlighting",
"properties": {
"rust-analyzer.semanticHighlighting.strings.enable": {
"markdownDescription": "Use semantic tokens for strings.\n\nIn some editors (e.g. vscode) semantic tokens override other highlighting grammars.\nBy disabling semantic tokens for strings, other grammars can be used to highlight\ntheir contents.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Signature Info",
"properties": {
"rust-analyzer.signatureInfo.detail": {
"markdownDescription": "Show full signature of the callable. Only shows parameters if disabled.",
"default": "full",
"type": "string",
"enum": [
"full",
"parameters"
],
"enumDescriptions": [
"Show the entire signature.",
"Show only the parameters."
]
}
}
},
{
"title": "Signature Info",
"properties": {
"rust-analyzer.signatureInfo.documentation.enable": {
"markdownDescription": "Show documentation.",
"default": true,
"type": "boolean"
}
}
},
{
"title": "Typing",
"properties": {
"rust-analyzer.typing.triggerChars": {
"markdownDescription": "Specify the characters allowed to invoke special on typing triggers.\n\n- typing `=` after `let` tries to smartly add `;` if `=` is followed by an existing\n expression\n- typing `=` between two expressions adds `;` when in statement position\n- typing `=` to turn an assignment into an equality comparison removes `;` when in\n expression position\n- typing `.` in a chain method call auto-indents\n- typing `{` or `(` in front of an expression inserts a closing `}` or `)` after the\n expression\n- typing `{` in a use item adds a closing `}` in the right place\n- typing `>` to complete a return type `->` will insert a whitespace after it\n- typing `<` in a path or type position inserts a closing `>` after the path or type.",
"default": "=.",
"type": [
"null",
"string"
]
}
}
},
{
"title": "Vfs",
"properties": {
"rust-analyzer.vfs.extraIncludes": {
"markdownDescription": "Additional paths to include in the VFS. Generally for code that is\ngenerated or otherwise managed by a build system outside of Cargo,\nthough Cargo might be the eventual consumer.",
"default": [],
"type": "array",
"items": {
"type": "string"
}
}
}
},
{
"title": "Workspace",
"properties": {
"rust-analyzer.workspace.discoverConfig": {
"markdownDescription": "Enables automatic discovery of projects using [`DiscoverWorkspaceConfig::command`].\n\n[`DiscoverWorkspaceConfig`] also requires setting `progress_label` and `files_to_watch`.\n`progress_label` is used for the title in progress indicators, whereas `files_to_watch`\nis used to determine which build system-specific files should be watched in order to\nreload rust-analyzer.\n\nBelow is an example of a valid configuration:\n```json\n\"rust-analyzer.workspace.discoverConfig\": {\n \"command\": [\n \"rust-project\",\n \"develop-json\"\n ],\n \"progressLabel\": \"rust-analyzer\",\n \"filesToWatch\": [\n \"BUCK\"\n ]\n}\n```\n\n## On `DiscoverWorkspaceConfig::command`\n\n**Warning**: This format is provisional and subject to change.\n\n[`DiscoverWorkspaceConfig::command`] *must* return a JSON object corresponding to\n`DiscoverProjectData::Finished`:\n\n```norun\n#[derive(Debug, Clone, Deserialize, Serialize)]\n#[serde(tag = \"kind\")]\n#[serde(rename_all = \"snake_case\")]\nenum DiscoverProjectData {\n Finished { buildfile: Utf8PathBuf, project: ProjectJsonData },\n Error { error: String, source: Option<String> },\n Progress { message: String },\n}\n```\n\nAs JSON, `DiscoverProjectData::Finished` is:\n\n```json\n{\n // the internally-tagged representation of the enum.\n \"kind\": \"finished\",\n // the file used by a non-Cargo build system to define\n // a package or target.\n \"buildfile\": \"rust-analyzer/BUILD\",\n // the contents of a rust-project.json, elided for brevity\n \"project\": {\n \"sysroot\": \"foo\",\n \"crates\": []\n }\n}\n```\n\nIt is encouraged, but not required, to use the other variants on `DiscoverProjectData`\nto provide a more polished end-user experience.\n\n`DiscoverWorkspaceConfig::command` may *optionally* include an `{arg}`, which will be\nsubstituted with the JSON-serialized form of the following enum:\n\n```norun\n#[derive(PartialEq, Clone, Debug, Serialize)]\n#[serde(rename_all = \"camelCase\")]\npub enum DiscoverArgument {\n Path(AbsPathBuf),\n Buildfile(AbsPathBuf),\n}\n```\n\nThe JSON representation of `DiscoverArgument::Path` is:\n\n```json\n{\n \"path\": \"src/main.rs\"\n}\n```\n\nSimilarly, the JSON representation of `DiscoverArgument::Buildfile` is:\n\n```json\n{\n \"buildfile\": \"BUILD\"\n}\n```\n\n`DiscoverArgument::Path` is used to find and generate a `rust-project.json`, and\ntherefore, a workspace, whereas `DiscoverArgument::buildfile` is used to to update an\nexisting workspace. As a reference for implementors, buck2's `rust-project` will likely\nbe useful: https://github.com/facebook/buck2/tree/main/integrations/rust-project.",
"default": null,
"anyOf": [
{
"type": "null"
},
{
"type": "object",
"properties": {
"command": {
"type": "array",
"items": {
"type": "string"
}
},
"progressLabel": {
"type": "string"
},
"filesToWatch": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
}
}
},
{
"title": "Workspace",
"properties": {
"rust-analyzer.workspace.symbol.search.excludeImports": {
"markdownDescription": "Exclude all imports from workspace symbol search.\n\nIn addition to regular imports (which are always excluded),\nthis option removes public imports (better known as re-exports)\nand removes imports that rename the imported symbol.",
"default": false,
"type": "boolean"
}
}
},
{
"title": "Workspace",
"properties": {
"rust-analyzer.workspace.symbol.search.kind": {
"markdownDescription": "Workspace symbol search kind.",
"default": "only_types",
"type": "string",
"enum": [
"only_types",
"all_symbols"
],
"enumDescriptions": [
"Search for types only.",
"Search for all symbols kinds."
]
}
}
},
{
"title": "Workspace",
"properties": {
"rust-analyzer.workspace.symbol.search.limit": {
"markdownDescription": "Limits the number of items returned from a workspace symbol search (Defaults to 128).\nSome clients like vs-code issue new searches on result filtering and don't require all results to be returned in the initial search.\nOther clients requires all results upfront and might require a higher limit.",
"default": 128,
"type": "integer",
"minimum": 0
}
}
},
{
"title": "Workspace",
"properties": {
"rust-analyzer.workspace.symbol.search.scope": {
"markdownDescription": "Workspace symbol search scope.",
"default": "workspace",
"type": "string",
"enum": [
"workspace",
"workspace_and_dependencies"
],
"enumDescriptions": [
"Search in current workspace only.",
"Search in current workspace and dependencies."
]
}
}
},
{
"title": "$generated-end"
}
],
"configurationDefaults": {
"explorer.fileNesting.patterns": {
"Cargo.toml": "Cargo.lock"
}
},
"problemPatterns": [
{
"name": "rustc",
"patterns": [
{
"regexp": "^(warning|warn|error)(?:\\[(.*?)\\])?: (.*)$",
"severity": 1,
"code": 2,
"message": 3
},
{
"regexp": "^[\\s->=]*(.*?):([1-9]\\d*):([1-9]\\d*)\\s*$",
"file": 1,
"line": 2,
"column": 3
}
]
},
{
"name": "rustc-json",
"patterns": [
{
"regexp": "^.*\"message\":{\"message\":\"([^\"]*).*?\"file_name\":\"([^\"]+).*?\"line_start\":(\\d+).*?\"line_end\":(\\d+).*?\"column_start\":(\\d+).*?\"column_end\":(\\d+).*}$",
"message": 1,
"file": 2,
"line": 3,
"endLine": 4,
"column": 5,
"endColumn": 6
}
]
},
{
"name": "rust-panic",
"patterns": [
{
"regexp": "^thread '.*' panicked at (.*):(\\d*):(\\d*):$",
"file": 1,
"line": 2,
"column": 3
},
{
"regexp": "(.*)",
"message": 1
}
]
}
],
"languages": [
{
"id": "ra_syntax_tree",
"extensions": [
".rast"
]
},
{
"id": "rust",
"extensions": [
".rs"
],
"aliases": [
"Rust",
"rs"
],
"configuration": "language-configuration.json"
}
],
"grammars": [
{
"language": "ra_syntax_tree",
"scopeName": "source.ra_syntax_tree",
"path": "ra_syntax_tree.tmGrammar.json"
}
],
"problemMatchers": [
{
"name": "rustc",
"owner": "rustc",
"source": "rustc",
"fileLocation": [
"autoDetect",
"${workspaceRoot}"
],
"pattern": "$rustc"
},
{
"name": "rustc-json",
"owner": "rustc",
"source": "rustc",
"fileLocation": [
"autoDetect",
"${workspaceRoot}"
],
"pattern": "$rustc-json"
},
{
"name": "rust-panic",
"owner": "rust-panic",
"source": "panic",
"fileLocation": [
"autoDetect",
"${workspaceRoot}"
],
"pattern": "$rust-panic"
},
{
"name": "rustc-watch",
"owner": "rustc",
"source": "rustc",
"fileLocation": [
"autoDetect",
"${workspaceRoot}"
],
"background": {
"beginsPattern": "^\\[Running\\b",
"endsPattern": "^\\[Finished running\\b"
},
"pattern": "$rustc"
}
],
"semanticTokenTypes": [
{
"id": "angle",
"description": "Style for < or >",
"superType": "punctuation"
},
{
"id": "arithmetic",
"description": "Style for arithmetic operators",
"superType": "operator"
},
{
"id": "attribute",
"description": "Style for attributes"
},
{
"id": "attributeBracket",
"description": "Style for attribute invocation brackets, that is the `#[` and `]` tokens",
"superType": "punctuation"
},
{
"id": "bitwise",
"description": "Style for bitwise operators",
"superType": "operator"
},
{
"id": "boolean",
"description": "Style for boolean literals",
"superType": "keyword"
},
{
"id": "brace",
"description": "Style for { or }",
"superType": "punctuation"
},
{
"id": "bracket",
"description": "Style for [ or ]",
"superType": "punctuation"
},
{
"id": "builtinAttribute",
"description": "Style for builtin attributes",
"superType": "attribute"
},
{
"id": "builtinType",
"description": "Style for builtin types",
"superType": "type"
},
{
"id": "character",
"description": "Style for character literals",
"superType": "string"
},
{
"id": "colon",
"description": "Style for :",
"superType": "punctuation"
},
{
"id": "comma",
"description": "Style for ,",
"superType": "punctuation"
},
{
"id": "comparison",
"description": "Style for comparison operators",
"superType": "operator"
},
{
"id": "constParameter",
"description": "Style for const generics"
},
{
"id": "const",
"description": "Style for consts",
"superType": "variable"
},
{
"id": "derive",
"description": "Style for derives",
"superType": "attribute"
},
{
"id": "deriveHelper",
"description": "Style for derive helpers",
"superType": "attribute"
},
{
"id": "dot",
"description": "Style for .",
"superType": "punctuation"
},
{
"id": "escapeSequence",
"description": "Style for char or byte escapes in strings"
},
{
"id": "formatSpecifier",
"description": "Style for {} placeholders in format strings"
},
{
"id": "invalidEscapeSequence",
"description": "Style for invalid char or byte escapes in strings"
},
{
"id": "label",
"description": "Style for labels"
},
{
"id": "lifetime",
"description": "Style for lifetimes"
},
{
"id": "logical",
"description": "Style for logic operators",
"superType": "operator"
},
{
"id": "macroBang",
"description": "Style for the ! token of macro calls",
"superType": "punctuation"
},
{
"id": "parenthesis",
"description": "Style for ( or )",
"superType": "punctuation"
},
{
"id": "procMacro",
"description": "Style for proc macro code",
"superType": "macro"
},
{
"id": "punctuation",
"description": "Style for generic punctuation"
},
{
"id": "operator",
"description": "Style for operators",
"superType": "punctuation"
},
{
"id": "selfKeyword",
"description": "Style for the self keyword",
"superType": "keyword"
},
{
"id": "selfTypeKeyword",
"description": "Style for the self type keyword",
"superType": "keyword"
},
{
"id": "semicolon",
"description": "Style for ;",
"superType": "punctuation"
},
{
"id": "static",
"description": "Style for statics",
"superType": "variable"
},
{
"id": "toolModule",
"description": "Style for tool module attributes",
"superType": "decorator"
},
{
"id": "typeAlias",
"description": "Style for type aliases",
"superType": "type"
},
{
"id": "union",
"description": "Style for C-style untagged unions",
"superType": "type"
},
{
"id": "unresolvedReference",
"description": "Style for names which can not be resolved due to compilation errors"
}
],
"semanticTokenModifiers": [
{
"id": "async",
"description": "Style for async functions and the `async` and `await` keywords"
},
{
"id": "attribute",
"description": "Style for elements within attributes"
},
{
"id": "callable",
"description": "Style for locals whose types implements one of the `Fn*` traits"
},
{
"id": "constant",
"description": "Style for compile-time constants"
},
{
"id": "consuming",
"description": "Style for locals that are being consumed when use in a function call"
},
{
"id": "controlFlow",
"description": "Style for control-flow related tokens, this includes the `?` operator"
},
{
"id": "crateRoot",
"description": "Style for names resolving to a crate root"
},
{
"id": "injected",
"description": "Style for doc-string injected highlighting like rust source blocks in documentation"
},
{
"id": "intraDocLink",
"description": "Style for intra doc links in doc-strings"
},
{
"id": "library",
"description": "Style for items that are defined outside of the current crate"
},
{
"id": "macro",
"description": "Style for tokens inside of macro calls"
},
{
"id": "mutable",
"description": "Style for mutable locals and statics as well as functions taking `&mut self`"
},
{
"id": "procMacro",
"description": "Style for tokens inside of proc-macro calls"
},
{
"id": "public",
"description": "Style for items that are from the current crate and are `pub`"
},
{
"id": "reference",
"description": "Style for locals behind a reference and functions taking `self` by reference"
},
{
"id": "trait",
"description": "Style for associated trait items"
},
{
"id": "unsafe",
"description": "Style for unsafe operations, like unsafe function calls, as well as the `unsafe` token"
}
],
"semanticTokenScopes": [
{
"language": "rust",
"scopes": {
"attribute": [
"meta.attribute.rust"
],
"boolean": [
"constant.language.boolean.rust"
],
"builtinType": [
"support.type.primitive.rust"
],
"constParameter": [
"constant.other.caps.rust"
],
"enum": [
"entity.name.type.enum.rust"
],
"formatSpecifier": [
"punctuation.section.embedded.rust"
],
"function": [
"entity.name.function.rust"
],
"interface": [
"entity.name.type.trait.rust"
],
"keyword": [
"keyword.other.rust"
],
"keyword.controlFlow": [
"keyword.control.rust"
],
"lifetime": [
"storage.modifier.lifetime.rust"
],
"macroBang": [
"entity.name.function.macro.rust"
],
"method": [
"entity.name.function.rust"
],
"struct": [
"entity.name.type.struct.rust"
],
"typeAlias": [
"entity.name.type.declaration.rust"
],
"union": [
"entity.name.type.union.rust"
],
"variable": [
"variable.other.rust"
],
"variable.constant": [
"variable.other.constant.rust"
],
"*.mutable": [
"markup.underline"
]
}
}
],
"menus": {
"commandPalette": [
{
"command": "rust-analyzer.viewHir",
"when": "inRustProject"
},
{
"command": "rust-analyzer.viewFileText",
"when": "inRustProject"
},
{
"command": "rust-analyzer.expandMacro",
"when": "inRustProject"
},
{
"command": "rust-analyzer.matchingBrace",
"when": "inRustProject"
},
{
"command": "rust-analyzer.parentModule",
"when": "inRustProject"
},
{
"command": "rust-analyzer.childModules",
"when": "inRustProject"
},
{
"command": "rust-analyzer.joinLines",
"when": "inRustProject"
},
{
"command": "rust-analyzer.run",
"when": "inRustProject"
},
{
"command": "rust-analyzer.debug",
"when": "inRustProject"
},
{
"command": "rust-analyzer.newDebugConfig",
"when": "inRustProject"
},
{
"command": "rust-analyzer.analyzerStatus",
"when": "inRustProject"
},
{
"command": "rust-analyzer.memoryUsage",
"when": "inRustProject"
},
{
"command": "rust-analyzer.reloadWorkspace",
"when": "inRustProject"
},
{
"command": "rust-analyzer.restartServer",
"when": "inRustProject"
},
{
"command": "rust-analyzer.onEnter",
"when": "inRustProject"
},
{
"command": "rust-analyzer.ssr",
"when": "inRustProject"
},
{
"command": "rust-analyzer.serverVersion",
"when": "inRustProject"
},
{
"command": "rust-analyzer.openDocs",
"when": "inRustProject"
},
{
"command": "rust-analyzer.openCargoToml",
"when": "inRustProject"
},
{
"command": "rust-analyzer.viewMemoryLayout",
"when": "inRustProject"
},
{
"command": "rust-analyzer.toggleLSPLogs",
"when": "inRustProject"
},
{
"command": "rust-analyzer.openWalkthrough"
},
{
"command": "rust-analyzer.syntaxTreeReveal",
"when": "false"
},
{
"command": "rust-analyzer.syntaxTreeCopy",
"when": "false"
},
{
"command": "rust-analyzer.syntaxTreeHideWhitespace",
"when": "false"
},
{
"command": "rust-analyzer.syntaxTreeShowWhitespace",
"when": "false"
}
],
"editor/context": [
{
"command": "rust-analyzer.peekTests",
"when": "inRustProject && editorTextFocus && editorLangId == rust",
"group": "navigation@1000"
},
{
"command": "rust-analyzer.openDocs",
"when": "inRustProject && editorTextFocus && editorLangId == rust",
"group": "navigation@1001"
}
],
"view/title": [
{
"command": "rust-analyzer.syntaxTreeHideWhitespace",
"group": "navigation",
"when": "view == rustSyntaxTree && !rustSyntaxTree.hideWhitespace"
},
{
"command": "rust-analyzer.syntaxTreeShowWhitespace",
"group": "navigation",
"when": "view == rustSyntaxTree && rustSyntaxTree.hideWhitespace"
}
],
"view/item/context": [
{
"command": "rust-analyzer.syntaxTreeCopy",
"group": "inline",
"when": "view == rustSyntaxTree"
},
{
"command": "rust-analyzer.syntaxTreeReveal",
"group": "inline",
"when": "view == rustSyntaxTree"
}
]
},
"views": {
"explorer": [
{
"icon": "$(package)",
"id": "rustDependencies",
"name": "Rust Dependencies",
"when": "inRustProject && config.rust-analyzer.showDependenciesExplorer"
}
],
"rustSyntaxTreeContainer": [
{
"icon": "$(file-code)",
"id": "rustSyntaxTree",
"name": "Rust Syntax Tree",
"when": "inRustProject && config.rust-analyzer.showSyntaxTree"
}
]
},
"viewsContainers": {
"activitybar": [
{
"id": "rustSyntaxTreeContainer",
"title": "Rust Syntax Tree",
"icon": "$(list-tree)"
}
]
},
"jsonValidation": [
{
"fileMatch": "rust-project.json",
"url": "https://json.schemastore.org/rust-project.json"
},
{
"fileMatch": ".rust-project.json",
"url": "https://json.schemastore.org/rust-project.json"
}
],
"walkthroughs": [
{
"id": "landing",
"title": "Learn about rust-analyzer",
"description": "A brief introduction to get started with rust-analyzer. Learn about key features and resources to help you get the most out of the extension.",
"steps": [
{
"id": "setup",
"title": "Useful Setup Tips",
"description": "There are a couple of things you might want to configure upfront to your tastes. We'll name a few here but be sure to check out the docs linked below!\n\n**Marking library sources as readonly**\n\nAdding the snippet on the right to your settings.json will mark all Rust library sources as readonly.\n\n**Check on Save**\n\nBy default, rust-analyzer will run ``cargo check`` on your codebase when you save a file, rendering diagnostics emitted by ``cargo check`` within your code. This can potentially collide with other ``cargo`` commands running concurrently, blocking them from running for a certain amount of time. In these cases it is recommended to disable the ``rust-analyzer.checkOnSave`` configuration and running the ``rust-analyzer: Run flycheck`` command on-demand instead.",
"media": {
"markdown": "./walkthrough-setup-tips.md"
}
},
{
"id": "docs",
"title": "Visit the docs!",
"description": "Confused about configurations? Want to learn more about rust-analyzer? Visit the [User Manual](https://rust-analyzer.github.io/book/)!",
"media": {
"image": "./icon.png",
"altText": "rust-analyzer logo"
},
"completionEvents": [
"onLink:https://rust-analyzer.github.io/book/"
]
},
{
"id": "faq",
"title": "FAQ",
"description": "What are these code hints that are being inserted into my code?\n\nThese hints are called inlay hints which rust-analyzer support and are enabled by default in VSCode. If you wish to disable them you can do so via the ``editor.inlayHints.enabled`` setting.",
"media": {
"image": "icon.png",
"altText": "rust-analyzer logo"
}
},
{
"id": "changelog",
"title": "Changelog",
"description": "Stay up-to-date with the latest changes in rust-analyzer. Check out the changelog [here](https://rust-analyzer.github.io/thisweek)!",
"media": {
"image": "icon.png",
"altText": "rust-analyzer logo"
},
"completionEvents": [
"onLink:https://rust-analyzer.github.io/thisweek"
]
}
]
}
]
}
}
Reference in New Issue View Git Blame Copy Permalink