Refresh generated neovim config
This commit is contained in:
@ -1,14 +1,15 @@
|
||||
==============================================================================
|
||||
Table of Contents *rustaceanvim.contents*
|
||||
|
||||
Introduction ··························································· |intro|
|
||||
Introduction ·············································· |rustaceanvim.intro|
|
||||
································································ |rustaceanvim|
|
||||
plugin configuration ····································· |rustaceanvim.config|
|
||||
LSP configuration utility ························· |rustaceanvim.config.server|
|
||||
························································ |rustaceanvim.neotest|
|
||||
···························································· |rustaceanvim.dap|
|
||||
|
||||
==============================================================================
|
||||
Introduction *intro*
|
||||
Introduction *rustaceanvim.intro*
|
||||
|
||||
This plugin automatically configures the `rust-analyzer` builtin LSP client
|
||||
and integrates with other rust tools.
|
||||
@ -41,15 +42,25 @@ It accepts the following subcommands:
|
||||
'expandMacro' - Expand macros recursively.
|
||||
'moveItem {up|down}' - Move items up or down.
|
||||
'hover {actions|range}' - Hover actions, or hover over visually selected range.
|
||||
'explainError' - Display a hover window with explanations form the Rust error index.
|
||||
Like |vim.diagnostic.goto_next|, |explainError| will cycle diagnostics,
|
||||
starting at the cursor position, until it can find a diagnostic with
|
||||
an error code.
|
||||
'renderDiagnostic' - Display a hover window with the rendered diagnostic,
|
||||
as displayed during `cargo build`.
|
||||
Like |vim.diagnostic.goto_next|, |renderDiagnostic| will cycle diagnostics,
|
||||
starting at the cursor position, until it can find a diagnostic with
|
||||
rendered data.
|
||||
'explainError {cycle?|current?}' - Display a hover window with explanations form the Rust error index.
|
||||
- If called with |cycle| or no args:
|
||||
Like |vim.diagnostic.goto_next|,
|
||||
|explainError| will cycle diagnostics,
|
||||
starting at the cursor position,
|
||||
until it can find a diagnostic with an error code.
|
||||
- If called with |current|:
|
||||
Searches for diagnostics only in the
|
||||
current cursor line.
|
||||
'renderDiagnostic {cycle?|current?}' - Display a hover window with the rendered diagnostic,
|
||||
as displayed during |cargo build|.
|
||||
- If called with |cycle| or no args:
|
||||
Like |vim.diagnostic.goto_next|,
|
||||
|renderDiagnostic| will cycle diagnostics,
|
||||
starting at the cursor position,
|
||||
until it can find a diagnostic with rendered data.
|
||||
- If called with |current|:
|
||||
Searches for diagnostics only in the
|
||||
current cursor line.
|
||||
'openCargo' - Open the Cargo.toml file for the current package.
|
||||
'openDocs' - Open docs.rs documentation for the symbol under the cursor.
|
||||
'parentModule' - Open the current module's parent module.
|
||||
@ -97,13 +108,13 @@ which is a `RustaceanOpts` table, in your neovim configuration.
|
||||
Example:
|
||||
|
||||
>lua
|
||||
---@type RustaceanOpts
|
||||
---@type rustaceanvim.Opts
|
||||
vim.g.rustaceanvim = {
|
||||
---@type RustaceanToolsOpts
|
||||
---@type rustaceanvim.tools.Opts
|
||||
tools = {
|
||||
-- ...
|
||||
},
|
||||
---@type RustaceanLspClientOpts
|
||||
---@type rustaceanvim.lsp.ClientOpts
|
||||
server = {
|
||||
on_attach = function(client, bufnr)
|
||||
-- Set keybindings, etc. here.
|
||||
@ -115,7 +126,7 @@ vim.g.rustaceanvim = {
|
||||
},
|
||||
-- ...
|
||||
},
|
||||
---@type RustaceanDapOpts
|
||||
---@type rustaceanvim.dap.Opts
|
||||
dap = {
|
||||
-- ...
|
||||
},
|
||||
@ -124,51 +135,68 @@ vim.g.rustaceanvim = {
|
||||
|
||||
Notes:
|
||||
|
||||
- `vim.g.rustaceanvim` can also be a function that returns a `RustaceanOpts` table.
|
||||
- `vim.g.rustaceanvim` can also be a function that returns a `rustaceanvim.Opts` table.
|
||||
- `server.settings`, by default, is a function that looks for a `rust-analyzer.json` file
|
||||
in the project root, to load settings from it. It falls back to an empty table.
|
||||
|
||||
|
||||
RustaceanOpts *RustaceanOpts*
|
||||
rustaceanvim.Opts *rustaceanvim.Opts*
|
||||
|
||||
Fields: ~
|
||||
{tools?} (RustaceanToolsOpts) Plugin options
|
||||
{server?} (RustaceanLspClientOpts) Language server client options
|
||||
{dap?} (RustaceanDapOpts) Debug adapter options
|
||||
{tools?} (rustaceanvim.tools.Opts) Plugin options
|
||||
{server?} (rustaceanvim.lsp.ClientOpts) Language server client options
|
||||
{dap?} (rustaceanvim.dap.Opts) Debug adapter options
|
||||
|
||||
|
||||
RustaceanToolsOpts *RustaceanToolsOpts*
|
||||
rustaceanvim.tools.Opts *rustaceanvim.tools.Opts*
|
||||
|
||||
Fields: ~
|
||||
{executor?} (RustaceanExecutor|executor_alias) The executor to use for runnables/debuggables
|
||||
{test_executor?} (RustaceanExecutor|test_executor_alias) The executor to use for runnables that are tests / testables
|
||||
{crate_test_executor?} (RustaceanExecutor|test_executor_alias) The executor to use for runnables that are crate test suites (--all-targets)
|
||||
{cargo_override?} (string) Set this to override the 'cargo' command for runnables, debuggables (etc., e.g. to 'cross'). If set, this takes precedence over 'enable_nextest'.
|
||||
{enable_nextest?} (boolean) Whether to enable nextest. If enabled, `cargo test` commands will be transformed to `cargo nextest run` commands. Defaults to `true` if cargo-nextest is detected. Ignored if `cargo_override` is set.
|
||||
{enable_clippy?} (boolean) Whether to enable clippy checks on save if a clippy installation is detected. Default: `true`
|
||||
{on_initialized?} (fun(health:RustAnalyzerInitializedStatus)) Function that is invoked when the LSP server has finished initializing
|
||||
{reload_workspace_from_cargo_toml?} (boolean) Automatically call `RustReloadWorkspace` when writing to a Cargo.toml file
|
||||
{hover_actions?} (RustaceanHoverActionsOpts) Options for hover actions
|
||||
{code_actions?} (RustaceanCodeActionOpts) Options for code actions
|
||||
{float_win_config?} (FloatWinConfig) Options applied to floating windows. See |api-win_config|.
|
||||
{create_graph?} (RustaceanCrateGraphConfig) Options for showing the crate graph based on graphviz and the dot
|
||||
{open_url?} (fun(url:string):nil) If set, overrides how to open URLs
|
||||
{rustc?} (RustcOpts) Options for `rustc`
|
||||
{executor?} (rustaceanvim.Executor|rustaceanvim.executor_alias)
|
||||
The executor to use for runnables/debuggables
|
||||
{test_executor?} (rustaceanvim.Executor|rustaceanvim.test_executor_alias)
|
||||
The executor to use for runnables that are tests / testables
|
||||
{crate_test_executor?} (rustaceanvim.Executor|rustaceanvim.test_executor_alias)
|
||||
The executor to use for runnables that are crate test suites (--all-targets)
|
||||
{cargo_override?} (string)
|
||||
Set this to override the 'cargo' command for runnables, debuggables (etc., e.g. to 'cross').
|
||||
If set, this takes precedence over 'enable_nextest'.
|
||||
{enable_nextest?} (boolean)
|
||||
Whether to enable nextest. If enabled, `cargo test` commands will be transformed to `cargo nextest run` commands.
|
||||
Defaults to `true` if cargo-nextest is detected. Ignored if `cargo_override` is set.
|
||||
{enable_clippy?} (boolean)
|
||||
Whether to enable clippy checks on save if a clippy installation is detected.
|
||||
Default: `true`
|
||||
{on_initialized?} (fun(health:rustaceanvim.RAInitializedStatus))
|
||||
Function that is invoked when the LSP server has finished initializing
|
||||
{reload_workspace_from_cargo_toml?} (boolean)
|
||||
Automatically call `RustReloadWorkspace` when writing to a Cargo.toml file
|
||||
{hover_actions?} (rustaceanvim.hover-actions.Opts) Options for hover actions
|
||||
{code_actions?} (rustaceanvim.code-action.Opts) Options for code actions
|
||||
{float_win_config?} (rustaceanvim.FloatWinConfig)
|
||||
Options applied to floating windows.
|
||||
See |api-win_config|.
|
||||
{create_graph?} (rustaceanvim.crate-graph.Opts)
|
||||
Options for showing the crate graph based on graphviz and the dot
|
||||
{open_url?} (fun(url:string):nil)
|
||||
If set, overrides how to open URLs
|
||||
{rustc?} (rustaceanvim.rustc.Opts)
|
||||
Options for `rustc`
|
||||
|
||||
|
||||
RustaceanExecutor *RustaceanExecutor*
|
||||
rustaceanvim.Executor *rustaceanvim.Executor*
|
||||
|
||||
Fields: ~
|
||||
{execute_command} (fun(cmd:string,args:string[],cwd:string|nil,opts?:RustaceanExecutorOpts))
|
||||
{execute_command} (fun(cmd:string,args:string[],cwd:string|nil,opts?:rustaceanvim.ExecutorOpts))
|
||||
|
||||
|
||||
RustaceanExecutorOpts *RustaceanExecutorOpts*
|
||||
rustaceanvim.ExecutorOpts *rustaceanvim.ExecutorOpts*
|
||||
|
||||
Fields: ~
|
||||
{bufnr?} (integer) The buffer from which the executor was invoked.
|
||||
{bufnr?} (integer)
|
||||
The buffer from which the executor was invoked.
|
||||
|
||||
|
||||
FloatWinConfig *FloatWinConfig*
|
||||
rustaceanvim.FloatWinConfig *rustaceanvim.FloatWinConfig*
|
||||
|
||||
Fields: ~
|
||||
{auto_focus?} (boolean)
|
||||
@ -179,162 +207,199 @@ FloatWinConfig *FloatWinConfig*
|
||||
|vim.api.nvim_open_win|
|
||||
|
||||
|
||||
executor_alias *executor_alias*
|
||||
rustaceanvim.executor_alias *rustaceanvim.executor_alias*
|
||||
|
||||
Type: ~
|
||||
"termopen"|"quickfix"|"toggleterm"|"vimux"
|
||||
|
||||
|
||||
test_executor_alias *test_executor_alias*
|
||||
rustaceanvim.test_executor_alias *rustaceanvim.test_executor_alias*
|
||||
|
||||
Type: ~
|
||||
executor_alias|"background"|"neotest"
|
||||
rustaceanvim.executor_alias|"background"|"neotest"
|
||||
|
||||
|
||||
RustaceanHoverActionsOpts *RustaceanHoverActionsOpts*
|
||||
rustaceanvim.hover-actions.Opts *rustaceanvim.hover-actions.Opts*
|
||||
|
||||
Fields: ~
|
||||
{replace_builtin_hover?} (boolean) Whether to replace Neovim's built-in `vim.lsp.buf.hover` with hover actions. Default: `true`
|
||||
{replace_builtin_hover?} (boolean)
|
||||
Whether to replace Neovim's built-in `vim.lsp.buf.hover` with hover actions.
|
||||
Default: `true`
|
||||
|
||||
|
||||
RustaceanCodeActionOpts *RustaceanCodeActionOpts*
|
||||
rustaceanvim.code-action.Opts *rustaceanvim.code-action.Opts*
|
||||
|
||||
Fields: ~
|
||||
{group_icon?} (string) Text appended to a group action
|
||||
{ui_select_fallback?} (boolean) Whether to fall back to `vim.ui.select` if there are no grouped code actions. Default: `false`
|
||||
{group_icon?} (string)
|
||||
Text appended to a group action
|
||||
{ui_select_fallback?} (boolean)
|
||||
Whether to fall back to `vim.ui.select` if there are no grouped code actions.
|
||||
Default: `false`
|
||||
|
||||
|
||||
lsp_server_health_status *lsp_server_health_status*
|
||||
rustaceanvim.lsp_server_health_status *rustaceanvim.lsp_server_health_status*
|
||||
|
||||
Type: ~
|
||||
"ok"|"warning"|"error"
|
||||
|
||||
|
||||
RustAnalyzerInitializedStatus *RustAnalyzerInitializedStatus*
|
||||
rustaceanvim.RAInitializedStatus *rustaceanvim.RAInitializedStatus*
|
||||
|
||||
Fields: ~
|
||||
{health} (lsp_server_health_status)
|
||||
{health} (rustaceanvim.lsp_server_health_status)
|
||||
|
||||
|
||||
RustaceanCrateGraphConfig *RustaceanCrateGraphConfig*
|
||||
rustaceanvim.crate-graph.Opts *rustaceanvim.crate-graph.Opts*
|
||||
|
||||
Fields: ~
|
||||
{backend?} (string) Backend used for displaying the graph. See: https://graphviz.org/docs/outputs/ Defaults to `"x11"` if unset.
|
||||
{output?} (string) Where to store the output. No output if unset. Relative path from `cwd`.
|
||||
{enabled_graphviz_backends?} (string[]) Override the enabled graphviz backends list, used for input validation and autocompletion.
|
||||
{pipe?} (string) Overide the pipe symbol in the shell command. Useful if using a shell that is not supported by this plugin.
|
||||
{backend?} (string)
|
||||
Backend used for displaying the graph.
|
||||
See: https://graphviz.org/docs/outputs/
|
||||
Defaults to `"x11"` if unset.
|
||||
{output?} (string)
|
||||
Where to store the output. No output if unset.
|
||||
Relative path from `cwd`.
|
||||
{enabled_graphviz_backends?} (string[])
|
||||
Override the enabled graphviz backends list, used for input validation and autocompletion.
|
||||
{pipe?} (string)
|
||||
Overide the pipe symbol in the shell command.
|
||||
Useful if using a shell that is not supported by this plugin.
|
||||
|
||||
|
||||
RustcOpts *RustcOpts*
|
||||
rustaceanvim.rustc.Opts *rustaceanvim.rustc.Opts*
|
||||
|
||||
Fields: ~
|
||||
{edition} (string) The edition to use. See https://rustc-dev-guide.rust-lang.org/guides/editions.html. Default '2021'.
|
||||
{default_edition?} (string)
|
||||
The default edition to use if it cannot be auto-detected.
|
||||
See https://rustc-dev-guide.rust-lang.org/guides/editions.html.
|
||||
Default '2021'.
|
||||
|
||||
|
||||
RustaceanLspClientOpts *RustaceanLspClientOpts*
|
||||
rustaceanvim.lsp.ClientOpts *rustaceanvim.lsp.ClientOpts*
|
||||
|
||||
Fields: ~
|
||||
{auto_attach?} (boolean|fun(bufnr:integer):boolean) Whether to automatically attach the LSP client. Defaults to `true` if the `rust-analyzer` executable is found.
|
||||
{cmd?} (string[]|fun():string[]) Command and arguments for starting rust-analyzer
|
||||
{root_dir?} (string|fun(filename:string,default:fun(filename:string):string|nil):string|nil) The directory to use for the attached LSP. Can be a function, which may return nil if no server should attach. The second argument contains the default implementation, which can be used for fallback behavior.
|
||||
{settings?} (table|fun(project_root:string|nil,default_settings:table):table) Setting passed to rust-analyzer. Defaults to a function that looks for a `rust-analyzer.json` file or returns an empty table. See https://rust-analyzer.github.io/manual.html#configuration.
|
||||
{standalone?} (boolean) Standalone file support (enabled by default). Disabling it may improve rust-analyzer's startup time.
|
||||
{logfile?} (string) The path to the rust-analyzer log file.
|
||||
{load_vscode_settings?} (boolean) Whether to search (upward from the buffer) for rust-analyzer settings in .vscode/settings json. If found, loaded settings will override configured options. Default: false
|
||||
{auto_attach?} (boolean|fun(bufnr:integer):boolean)
|
||||
Whether to automatically attach the LSP client.
|
||||
Defaults to `true` if the `rust-analyzer` executable is found.
|
||||
{cmd?} (string[]|fun():string[])
|
||||
Command and arguments for starting rust-analyzer
|
||||
{root_dir?} (string|fun(filename:string,default:fun(filename:string):string|nil):string|nil)
|
||||
The directory to use for the attached LSP.
|
||||
Can be a function, which may return nil if no server should attach.
|
||||
The second argument contains the default implementation, which can be used for fallback behavior.
|
||||
{settings?} (table|fun(project_root:string|nil,default_settings:table):table)
|
||||
Setting passed to rust-analyzer.
|
||||
Defaults to a function that looks for a `rust-analyzer.json` file or returns an empty table.
|
||||
See https://rust-analyzer.github.io/manual.html#configuration.
|
||||
{standalone?} (boolean)
|
||||
Standalone file support (enabled by default).
|
||||
Disabling it may improve rust-analyzer's startup time.
|
||||
{logfile?} (string)
|
||||
The path to the rust-analyzer log file.
|
||||
{load_vscode_settings?} (boolean)
|
||||
Whether to search (upward from the buffer) for rust-analyzer settings in .vscode/settings json.
|
||||
If found, loaded settings will override configured options.
|
||||
Default: true
|
||||
|
||||
See: ~
|
||||
|vim.lsp.ClientConfig|
|
||||
|
||||
|
||||
RustaceanDapOpts *RustaceanDapOpts*
|
||||
rustaceanvim.dap.Opts *rustaceanvim.dap.Opts*
|
||||
|
||||
Fields: ~
|
||||
{adapter?} (DapExecutableConfig|DapServerConfig|disable|fun():DapExecutableConfig|DapServerConfig|disable) @field autoload_configurations boolean Whether to autoload nvim-dap configurations when rust-analyzer has attached? Default: `true`.
|
||||
{autoload_configurations} (boolean)
|
||||
Whether to autoload nvim-dap configurations when rust-analyzer has attached?
|
||||
Default: `true`.
|
||||
|
||||
|
||||
disable *disable*
|
||||
rustaceanvim.disable *rustaceanvim.disable*
|
||||
|
||||
Type: ~
|
||||
false
|
||||
|
||||
|
||||
DapCommand *DapCommand*
|
||||
rustaceanvim.dap.Command *rustaceanvim.dap.Command*
|
||||
|
||||
Type: ~
|
||||
string
|
||||
|
||||
|
||||
DapExecutableConfig *DapExecutableConfig*
|
||||
rustaceanvim.dap.executable.Config *rustaceanvim.dap.executable.Config*
|
||||
|
||||
Fields: ~
|
||||
{type} (dap_adapter_type_executable) The type of debug adapter.
|
||||
{command} (string) Default: `"lldb-vscode"`.
|
||||
{args?} (string) Default: unset.
|
||||
{name?} (string) Default: `"lldb"`.
|
||||
{type} (rustaceanvim.dap.adapter.types.executable)
|
||||
The type of debug adapter.
|
||||
{command} (string) Default: `"lldb-vscode"`.
|
||||
{args?} (string) Default: unset.
|
||||
{name?} (string) Default: `"lldb"`.
|
||||
|
||||
|
||||
DapServerConfig *DapServerConfig*
|
||||
rustaceanvim.dap.server.Config *rustaceanvim.dap.server.Config*
|
||||
|
||||
Fields: ~
|
||||
{type} (dap_adapter_type_server) The type of debug adapter.
|
||||
{host?} (string) The host to connect to.
|
||||
{port} (string) The port to connect to.
|
||||
{executable} (DapExecutable) The executable to run
|
||||
{type} (rustaceanvim.dap.adapter.types.server) The type of debug adapter.
|
||||
{host?} (string) The host to connect to.
|
||||
{port} (string) The port to connect to.
|
||||
{executable} (rustaceanvim.dap.Executable) The executable to run
|
||||
{name?} (string)
|
||||
|
||||
|
||||
DapExecutable *DapExecutable*
|
||||
rustaceanvim.dap.Executable *rustaceanvim.dap.Executable*
|
||||
|
||||
Fields: ~
|
||||
{command} (string) The executable.
|
||||
{args} (string[]) Its arguments.
|
||||
|
||||
|
||||
dap_adapter_type_executable *dap_adapter_type_executable*
|
||||
*rustaceanvim.dap.adapter.types.executable*
|
||||
rustaceanvim.dap.adapter.types.executable
|
||||
|
||||
Type: ~
|
||||
|
||||
|
||||
|
||||
dap_adapter_type_server *dap_adapter_type_server*
|
||||
rustaceanvim.dap.adapter.types.server *rustaceanvim.dap.adapter.types.server*
|
||||
|
||||
Type: ~
|
||||
|
||||
|
||||
|
||||
DapClientConfig : Configuration *DapClientConfig*
|
||||
*rustaceanvim.dap.client.Config*
|
||||
rustaceanvim.dap.client.Config : Configuration
|
||||
|
||||
Fields: ~
|
||||
{type} (string) The dap adapter to use
|
||||
{type} (string) The dap adapter to use
|
||||
{name} (string)
|
||||
{request} (dap_config_request_launch|dap_config_request_attach|dap_config_request_custom) The type of dap session
|
||||
{cwd?} (string) Current working directory
|
||||
{program?} (string) Path to executable for most DAP clients
|
||||
{args?} (string[]) Optional args to DAP client, not valid for all client types
|
||||
{env?} (EnvironmentMap) Environmental variables
|
||||
{initCommands?} (string[]) Initial commands to run, `lldb` clients only
|
||||
{coreConfigs?} (table) Essential config values for `probe-rs` client, see https://probe.rs/docs/tools/debugger/
|
||||
{request} (rustaceanvim.dap.config.requests.launch|rustaceanvim.dap.config.requests.attach|rustaceanvim.dap.config.requests.custom) The type of dap session
|
||||
{cwd?} (string) Current working directory
|
||||
{program?} (string) Path to executable for most DAP clients
|
||||
{args?} (string[]) Optional args to DAP client, not valid for all client types
|
||||
{env?} (rustaceanvim.EnvironmentMap) Environmental variables
|
||||
{initCommands?} (string[]) Initial commands to run, `lldb` clients only
|
||||
{coreConfigs?} (table)
|
||||
Essential config values for `probe-rs` client, see https://probe.rs/docs/tools/debugger/
|
||||
|
||||
|
||||
EnvironmentMap *EnvironmentMap*
|
||||
rustaceanvim.EnvironmentMap *rustaceanvim.EnvironmentMap*
|
||||
|
||||
Type: ~
|
||||
table<string,string[]>
|
||||
|
||||
|
||||
dap_config_request_launch *dap_config_request_launch*
|
||||
rustaceanvim.dap.config.requests.launch*rustaceanvim.dap.config.requests.launch*
|
||||
|
||||
Type: ~
|
||||
|
||||
|
||||
|
||||
dap_config_request_attach *dap_config_request_attach*
|
||||
rustaceanvim.dap.config.requests.attach*rustaceanvim.dap.config.requests.attach*
|
||||
|
||||
Type: ~
|
||||
|
||||
|
||||
|
||||
dap_config_request_custom *dap_config_request_custom*
|
||||
rustaceanvim.dap.config.requests.custom*rustaceanvim.dap.config.requests.custom*
|
||||
|
||||
Type: ~
|
||||
|
||||
@ -349,13 +414,13 @@ M.get_codelldb_adapter({codelldb_path}, {liblldb_path})
|
||||
{liblldb_path} (string) Path to the liblldb dynamic library
|
||||
|
||||
Returns: ~
|
||||
(DapServerConfig)
|
||||
(rustaceanvim.dap.server.Config)
|
||||
|
||||
|
||||
==============================================================================
|
||||
LSP configuration utility *rustaceanvim.config.server*
|
||||
|
||||
LoadRASettingsOpts *LoadRASettingsOpts*
|
||||
rustaceanvim.LoadRASettingsOpts *rustaceanvim.LoadRASettingsOpts*
|
||||
|
||||
Fields: ~
|
||||
{settings_file_pattern} (string|nil) File name or pattern to search for. Defaults to 'rust-analyzer.json'
|
||||
@ -368,8 +433,8 @@ server.load_rust_analyzer_settings({project_root}, {opts})
|
||||
falling back to the default settings if none is found or if it cannot be decoded.
|
||||
|
||||
Parameters: ~
|
||||
{project_root} (string|nil) The project root
|
||||
{opts} (LoadRASettingsOpts|nil)
|
||||
{project_root} (string|nil) The project root
|
||||
{opts} (rustaceanvim.LoadRASettingsOpts|nil)
|
||||
|
||||
Returns: ~
|
||||
(table) server_settings
|
||||
@ -410,4 +475,31 @@ Note: If you use this adapter, do not add the neotest-rust adapter
|
||||
(another plugin).
|
||||
|
||||
|
||||
==============================================================================
|
||||
*rustaceanvim.dap*
|
||||
|
||||
|
||||
The DAP integration requires `nvim-dap` https://github.com/mfussenegger/nvim-dap
|
||||
(Please read the plugin's documentation, see |dap-adapter|)
|
||||
and a debug adapter (e.g. `lldb` https://lldb.llvm.org/
|
||||
or `codelldb` https://github.com/vadimcn/codelldb).
|
||||
|
||||
By default, this plugin will silently attempt to autoload |dap-configuration|s
|
||||
when the LSP client attaches.
|
||||
You can call them with `require('dap').continue()` or `:DapContinue` once
|
||||
they have been loaded. The feature can be disabled by setting
|
||||
`vim.g.rustaceanvim.dap.autoload_configurations = false`.
|
||||
|
||||
- `:RustLsp debuggables` will only load debug configurations
|
||||
created by `rust-analyzer`.
|
||||
- `require('dap').continue()` will load all Rust debug configurations,
|
||||
including those specified in a `.vscode/launch.json`
|
||||
(see |dap-launch.json|)
|
||||
|
||||
IMPORTANT: Note that rustaceanvim may only be able to load DAP configurations
|
||||
when rust-analyzer has finished initializing (which may be after
|
||||
the client attaches, in large projects). This means that the
|
||||
DAP configurations may not be loaded immediately upon startup.
|
||||
|
||||
|
||||
vim:tw=78:ts=8:noet:ft=help:norl:
|
||||
|
||||
@ -1,38 +1,36 @@
|
||||
DapClientConfig rustaceanvim.txt /*DapClientConfig*
|
||||
DapCommand rustaceanvim.txt /*DapCommand*
|
||||
DapExecutable rustaceanvim.txt /*DapExecutable*
|
||||
DapExecutableConfig rustaceanvim.txt /*DapExecutableConfig*
|
||||
DapServerConfig rustaceanvim.txt /*DapServerConfig*
|
||||
EnvironmentMap rustaceanvim.txt /*EnvironmentMap*
|
||||
FloatWinConfig rustaceanvim.txt /*FloatWinConfig*
|
||||
LoadRASettingsOpts rustaceanvim.txt /*LoadRASettingsOpts*
|
||||
M.get_codelldb_adapter rustaceanvim.txt /*M.get_codelldb_adapter*
|
||||
RustAnalyzerInitializedStatus rustaceanvim.txt /*RustAnalyzerInitializedStatus*
|
||||
RustaceanCodeActionOpts rustaceanvim.txt /*RustaceanCodeActionOpts*
|
||||
RustaceanCrateGraphConfig rustaceanvim.txt /*RustaceanCrateGraphConfig*
|
||||
RustaceanDapOpts rustaceanvim.txt /*RustaceanDapOpts*
|
||||
RustaceanExecutor rustaceanvim.txt /*RustaceanExecutor*
|
||||
RustaceanExecutorOpts rustaceanvim.txt /*RustaceanExecutorOpts*
|
||||
RustaceanHoverActionsOpts rustaceanvim.txt /*RustaceanHoverActionsOpts*
|
||||
RustaceanLspClientOpts rustaceanvim.txt /*RustaceanLspClientOpts*
|
||||
RustaceanOpts rustaceanvim.txt /*RustaceanOpts*
|
||||
RustaceanToolsOpts rustaceanvim.txt /*RustaceanToolsOpts*
|
||||
RustcOpts rustaceanvim.txt /*RustcOpts*
|
||||
dap_adapter_type_executable rustaceanvim.txt /*dap_adapter_type_executable*
|
||||
dap_adapter_type_server rustaceanvim.txt /*dap_adapter_type_server*
|
||||
dap_config_request_attach rustaceanvim.txt /*dap_config_request_attach*
|
||||
dap_config_request_custom rustaceanvim.txt /*dap_config_request_custom*
|
||||
dap_config_request_launch rustaceanvim.txt /*dap_config_request_launch*
|
||||
disable rustaceanvim.txt /*disable*
|
||||
executor_alias rustaceanvim.txt /*executor_alias*
|
||||
intro rustaceanvim.txt /*intro*
|
||||
lsp_server_health_status rustaceanvim.txt /*lsp_server_health_status*
|
||||
rustaceanvim rustaceanvim.txt /*rustaceanvim*
|
||||
rustaceanvim.EnvironmentMap rustaceanvim.txt /*rustaceanvim.EnvironmentMap*
|
||||
rustaceanvim.Executor rustaceanvim.txt /*rustaceanvim.Executor*
|
||||
rustaceanvim.ExecutorOpts rustaceanvim.txt /*rustaceanvim.ExecutorOpts*
|
||||
rustaceanvim.FloatWinConfig rustaceanvim.txt /*rustaceanvim.FloatWinConfig*
|
||||
rustaceanvim.LoadRASettingsOpts rustaceanvim.txt /*rustaceanvim.LoadRASettingsOpts*
|
||||
rustaceanvim.Opts rustaceanvim.txt /*rustaceanvim.Opts*
|
||||
rustaceanvim.RAInitializedStatus rustaceanvim.txt /*rustaceanvim.RAInitializedStatus*
|
||||
rustaceanvim.code-action.Opts rustaceanvim.txt /*rustaceanvim.code-action.Opts*
|
||||
rustaceanvim.config rustaceanvim.txt /*rustaceanvim.config*
|
||||
rustaceanvim.config.server rustaceanvim.txt /*rustaceanvim.config.server*
|
||||
rustaceanvim.contents rustaceanvim.txt /*rustaceanvim.contents*
|
||||
rustaceanvim.crate-graph.Opts rustaceanvim.txt /*rustaceanvim.crate-graph.Opts*
|
||||
rustaceanvim.dap rustaceanvim.txt /*rustaceanvim.dap*
|
||||
rustaceanvim.dap.Command rustaceanvim.txt /*rustaceanvim.dap.Command*
|
||||
rustaceanvim.dap.Executable rustaceanvim.txt /*rustaceanvim.dap.Executable*
|
||||
rustaceanvim.dap.Opts rustaceanvim.txt /*rustaceanvim.dap.Opts*
|
||||
rustaceanvim.dap.adapter.types.executable rustaceanvim.txt /*rustaceanvim.dap.adapter.types.executable*
|
||||
rustaceanvim.dap.adapter.types.server rustaceanvim.txt /*rustaceanvim.dap.adapter.types.server*
|
||||
rustaceanvim.dap.client.Config rustaceanvim.txt /*rustaceanvim.dap.client.Config*
|
||||
rustaceanvim.dap.executable.Config rustaceanvim.txt /*rustaceanvim.dap.executable.Config*
|
||||
rustaceanvim.dap.server.Config rustaceanvim.txt /*rustaceanvim.dap.server.Config*
|
||||
rustaceanvim.disable rustaceanvim.txt /*rustaceanvim.disable*
|
||||
rustaceanvim.executor_alias rustaceanvim.txt /*rustaceanvim.executor_alias*
|
||||
rustaceanvim.hover-actions.Opts rustaceanvim.txt /*rustaceanvim.hover-actions.Opts*
|
||||
rustaceanvim.intro rustaceanvim.txt /*rustaceanvim.intro*
|
||||
rustaceanvim.lsp.ClientOpts rustaceanvim.txt /*rustaceanvim.lsp.ClientOpts*
|
||||
rustaceanvim.lsp_server_health_status rustaceanvim.txt /*rustaceanvim.lsp_server_health_status*
|
||||
rustaceanvim.mason mason.txt /*rustaceanvim.mason*
|
||||
rustaceanvim.neotest rustaceanvim.txt /*rustaceanvim.neotest*
|
||||
rustaceanvim.rustc.Opts rustaceanvim.txt /*rustaceanvim.rustc.Opts*
|
||||
rustaceanvim.test_executor_alias rustaceanvim.txt /*rustaceanvim.test_executor_alias*
|
||||
rustaceanvim.tools.Opts rustaceanvim.txt /*rustaceanvim.tools.Opts*
|
||||
server.create_client_capabilities rustaceanvim.txt /*server.create_client_capabilities*
|
||||
server.load_rust_analyzer_settings rustaceanvim.txt /*server.load_rust_analyzer_settings*
|
||||
test_executor_alias rustaceanvim.txt /*test_executor_alias*
|
||||
|
||||
Reference in New Issue
Block a user