mason-nvim-lint
mason-nvim-lint copied to clipboard
Extension to mason.nvim that makes it easier to use nvim-lint with mason.nvim
mason-nvim-lint
mason-nvim-lint
is a Neovim plugin that closes a gap between mason.nvim
and nvim-lint
, it allows install linters configured in nvim-lint
.
Requirements
- neovim
>= 0.7.0
-
mason.nvim
-
nvim-lint
Installation
Lazy
{
"williamboman/mason.nvim",
"mfussenegger/nvim-lint",
"rshkarin/mason-nvim-lint",
}
Packer
use {
"williamboman/mason.nvim",
"mfussenegger/nvim-lint",
"rshkarin/mason-nvim-lint",
}
Setup
It's crucial to setup plugins in the following order:
-
mason.nvim
-
nvim-lint
-
mason-nvim-lint
Otherwise, mason-nvim-lint
will not have enough information about configured linters and access to the mason's registry.
To learn about the available settings and configurations, please refer the Configuration section.
Configuration
You can configure the behavior of mason-nvim-lint
by passing the configuration during the calling of the setup()
function.
All available settings are provided in default configuration section.
Example:
require("mason-nvim-lint").setup()
Default configuration
local DEFAULT_SETTINGS = {
-- A list of linters to automatically install if they're not already installed. Example: { "eslint_d", "revive" }
-- This setting has no relation with the `automatic_installation` setting.
-- Names of linters should be taken from the mason's registry.
---@type string[]
ensure_installed = {},
-- Whether linters that are set up (via nvim-lint) should be automatically installed if they're not already installed.
-- It tries to find the specified linters in the mason's registry to proceed with installation.
-- This setting has no relation with the `ensure_installed` setting.
---@type boolean
automatic_installation = true,
-- Disables warning notifications about misconfigurations such as invalid linter entries and incorrect plugin load order.
quiet_mode = false,
}
Basic Customization
Using this configuration, only linters specified in ensure_installed
will be installed, ones specified in nvim-lint
will be ignored.
NOTE: The linters in ensure_installed
should be written in the format of the mason's registry (https://mason-registry.dev/).
require ('mason-nvim-lint').setup({
ensure_installed = {'eslint_d', 'revive'},
})
Copyright
This project relies heavily on mason-lspconfig.nvim.