Files
mason-conform.nvim/README.md
T
Andreas Palm 882a4449e5 feat: Add config opt 'ignore_install'
This option allows the caller to define a list of conform formatters
that should be ignored during the install process. This might be useful
if the caller already have this tools installed and prefer not to have
them downloaded again by mason.
2024-05-19 13:22:23 +02:00

44 lines
1.3 KiB
Markdown

# mason-conform.nvim
Auto install formatters registered with `conform.nvim` via [Mason](https://github.com/williamboman/mason.nvim).
# Install
```lua
require("lazy").setup({
"williamboman/mason.nvim",
"stevearc/conform.nvim",
"zapling/mason-conform.nvim",
})
```
# Setup
It's crucial to setup plugins in the following order:
- `mason.nvim`
- `conform.nvim`
- `mason-conform.nvim`
Otherwise `mason-conform.nvim` will not have enough information about configured formatters and
access the mason registry.
# Configuration
```lua
require("mason-conform").setup({
ignore_install = {'prettier'} -- List of formatters to ignore during install
})
```
# Available formatters
Only formatters that are available in the [mason registry](https://github.com/mason-org/mason-registry)
can be downloaded automatically. If the formatter is available in the registry and it's not being
downloaded, this plugin might be missing a `conform` => `mason` mapping in the file [lua/mason-conform/mapping.lua](lua/mason-conform/mapping.lua).
# License
`mason-conform.nvim` is a blatant copy of [mason-nvim-lint](https://github.com/rshkarin/mason-nvim-lint)
which in turn takes heavy insperation from [mason-lspconfig.nvim](https://github.com/williamboman/mason-lspconfig.nvim)