diff options
| author | William Boman <william@redwill.se> | 2022-07-15 19:50:58 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-15 19:50:58 +0200 |
| commit | 9a73aaa118f5e5bb6da9f38541685ea143bdb023 (patch) | |
| tree | 999fdf44194890fda884fddcbe1058dc48922085 /doc | |
| parent | docs: update reference.md (#78) (diff) | |
| download | mason-9a73aaa118f5e5bb6da9f38541685ea143bdb023.tar mason-9a73aaa118f5e5bb6da9f38541685ea143bdb023.tar.gz mason-9a73aaa118f5e5bb6da9f38541685ea143bdb023.tar.bz2 mason-9a73aaa118f5e5bb6da9f38541685ea143bdb023.tar.lz mason-9a73aaa118f5e5bb6da9f38541685ea143bdb023.tar.xz mason-9a73aaa118f5e5bb6da9f38541685ea143bdb023.tar.zst mason-9a73aaa118f5e5bb6da9f38541685ea143bdb023.zip | |
docs: update mason-lspconfig (#79)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/mason-lspconfig.txt | 39 | ||||
| -rw-r--r-- | doc/mason.txt | 15 |
2 files changed, 42 insertions, 12 deletions
diff --git a/doc/mason-lspconfig.txt b/doc/mason-lspconfig.txt index e200067a..ddeda56c 100644 --- a/doc/mason-lspconfig.txt +++ b/doc/mason-lspconfig.txt @@ -95,17 +95,32 @@ Example: } ============================================================================== -AUTOMATIC SERVER SETUP - *mason-lspconfig-automatic-server-setup* +DYNAMIC SERVER SETUP *mason-lspconfig-dynamic-server-setup* -`mason-lspconfig` provides opt-in functionality that allow you to -automatically set up LSP servers installed with `mason.nvim`, without having -to edit your Neovim configuration for every single server you want to use. -This is also convenient if you want to use `mason.nvim` as the control for -which servers to set up. It also makes it possible to set up newly installed -servers without having to restart Neovim! +`mason-lspconfig` provides extra opt-in functionality that allow you to set up +LSP servers installed with `mason.nvim` without having to manually edit your +Neovim configuration for every single server you want to use. This is also +convenient if you want to use `mason.nvim` as the main control mechanism for +which servers to set up. It also makes it possible to use newly installed +servers without having to restart Neovim! Example: -Refer to |mason-lspconfig.setup_handlers()| for more information! + require("mason").setup() + require("mason-lspconfig").setup() + require("mason-lspconfig").setup_handlers { + -- The first entry (without a key) will be the default handler + -- and will be called for each installed server that doesn't have + -- a dedicated handler. + function (server_name) -- default handler (optional) + require("lspconfig")[server_name].setup {} + end, + -- Next, you can provide targeted overrides for specific servers. + -- For example, a handler override for the `rust_analyzer`: + ["rust_analyzer"] = function () + require("rust-tools").setup {} + end + } + +Refer to |mason-lspconfig.setup_handlers()| for more information. ============================================================================== Lua module: mason-lspconfig @@ -123,10 +138,10 @@ setup_handlers({handlers}) `function (server_name: string)`. It has the following structure: require("mason-lspconfig").setup_handlers({ + -- The first entry (without a key) will be the default handler + -- and will be called for each installed server that doesn't have + -- a dedicated handler. function (server_name) -- default handler (optional) - -- The first entry (without a key) will be the default handler - -- and will be called for each installed server that doesn't have - -- a dedicated handler. require("lspconfig")[server_name].setup {} end, -- Next, you can provide targeted overrides for specific servers. diff --git a/doc/mason.txt b/doc/mason.txt index 18abe901..4221e51d 100644 --- a/doc/mason.txt +++ b/doc/mason.txt @@ -19,6 +19,21 @@ Neovim's PATH during setup, allowing easy access for the builtin shell/terminal as well as other 3rd party plugins. ============================================================================== +EXTENSIONS *mason-extensions* + + + *mason-extensions-lspconfig* +`mason-lspconfig` is a native extension to `mason.nvim` that ships with +`mason.nvim`. It bridges `mason.nvim` with the `lspconfig` plugin in order to +make it easier to use the both plugins together. + +It is recommended to use this extension if you use `lspconfig`. To use this +extension, make sure to set it up after `mason.nvim`, like so: + + require("mason").setup() + require("mason-lspconfig").setup() + +============================================================================== REQUIREMENTS *mason-requirements* `mason.nvim` relaxes the minimum requirements by attempting multiple different |
