mossy.nvim

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 14 Open GitHub ↗

:mushroom: a simple and opinionated development plugin.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# mossy.nvim

:mushroom: a simple and opinionated development plugin.

```lua
local sources = require("mossy.sources")

-- use formatters for your favourite languages
sources:setup({
  "treefmt",
  "clang-format",
  "nixfmt",
  "shfmt",
  "stylua",
})

-- add a formatter for multiple languages
sources:add("prettier"):with({
  filetypes = { "html", "markdown", "astro", "vue" },
})

-- configure custom formatters
sources:add({
  name = "typstyle",
  cmd = "typstyle",
  method = "formatting",
  filetypes = { "typst" },
  stdin = true,
})

-- add a keymap to format your buffer
vim.keymap.set("n", "<localleader>f", require("mossy").format)
```

inspired by:
- [none-ls](https://github.com/nvimtools/none-ls.nvim) - Use Neovim as a language server to inject LSP diagnostics, code actions, and more via Lua.
- [guard.nvim](https://github.com/nvimdev/guard.nvim) - Lightweight, fast and async formatting and linting plugin for Neovim

## :sparkles: features

- [x] `ft()`: easy declaration of formatters for each filetype
- [x] `ft():use()`: ordered formatter declaration
- [x] `formatter.args`: dynamic arguments for formatters
- [x] `formatter.cond`: conditional formatters: use a predicate to enable formatter
- [x] lsp fallback: use an lsp server to format the file if others failed
- [ ] *linters*: support for lsp linters
- [ ] *nvim events*: use autocmds to extend mossy's behaviour

## :lock: requirements

- Neovim `>= 0.10.0`
- [nvim-nio](https://github.com/nvim-neotest/nvim-nio)

## :package: installation

mossy can be installed by adding this to your `lua/plugins/init.lua`:

```lua
{
  'comfysage/mossy.nvim',
  after = function()
    vim.keymap.set('n', '<localleader>f', require('mossy').format)
  end,
}
```

## :gear: configuration

Below is the default configuration.

```lua
{
	enable = true,
	defaults = {
		formatting = {
			format_on_save = true,
			use_lsp_fallback = true,
		},
		diagnostics = {},
	},
	log_level = vim.log.levels.INFO,
}
```

mossy.nvim

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README