diff options
| -rw-r--r-- | README.md | 8 | ||||
| -rw-r--r-- | doc/reference.md | 12 | ||||
| -rw-r--r-- | lua/mason-lspconfig/settings.lua | 2 |
3 files changed, 13 insertions, 9 deletions
@@ -6,7 +6,7 @@ <img src="https://user-images.githubusercontent.com/6705160/177613416-0c0354d2-f431-40d8-87f0-21310f0bba0e.png" alt="mason.nvim" /> <p align="center"> - Lightweight package manager for Neovim that runs everywhere Neovim runs.<br /> + Portable package manager for Neovim that runs everywhere Neovim runs.<br /> Easily install and manage LSP servers, DAP servers, linters, and formatters. </p> @@ -185,9 +185,9 @@ local DEFAULT_SETTINGS = { ## `mason-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. +`mason-lspconfig` is a extension that ships with `mason.nvim`. It bridges `mason.nvim` with the +[`lspconfig`](https://github.com/neovim/nvim-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: diff --git a/doc/reference.md b/doc/reference.md index d1349ab7..8caa4134 100644 --- a/doc/reference.md +++ b/doc/reference.md @@ -1,5 +1,11 @@ # Mason API reference +This document contains the API reference for `mason.nvim`'s' public APIs. +The intended audience of this document are plugin developers and people who want to further customize their own Neovim +configuration. + +Note that APIs not listed in this document are not considered public, and are subject to unannounced, breaking, changes. + - [Architecture diagram](#architecture-diagram) - [`PackageSpec`](#packagespec) - [`Package`](#package) @@ -30,10 +36,6 @@ - [`EventEmitter:once({event, handler})`](#eventemitteronceevent-handler) - [`EventEmitter:off({event}, {handler})`](#eventemitteroffevent-handler) -This document contains the API reference for `mason.nvim`'s' public APIs. -The intended audience of this document are plugin developers and people who want to further customize their own Neovim -configuration. - ## Architecture diagram  @@ -54,6 +56,8 @@ configuration. ## `Package` +Module: [`"mason-core.package"`](../lua/mason-core/package/init.lua) + The `Package` class encapsulates the installation instructions and metadata about a Mason package. **Events** diff --git a/lua/mason-lspconfig/settings.lua b/lua/mason-lspconfig/settings.lua index 23d1bdfb..a405f95c 100644 --- a/lua/mason-lspconfig/settings.lua +++ b/lua/mason-lspconfig/settings.lua @@ -2,7 +2,7 @@ local M = {} ---@class MasonLspconfigSettings local DEFAULT_SETTINGS = { - -- A list of servers to automatically install if they're not already installed. Example: { "rust-analyzer@nightly", "sumneko_lua" } + -- A list of servers to automatically install if they're not already installed. Example: { "rust_analyzer@nightly", "sumneko_lua" } -- This setting has no relation with the `automatic_installation` setting. ensure_installed = {}, |