minimal-format.nvim

 cljoly/minimal-format.nvim

A simple & powerful formatting plugin that extends neovim just a little bit to automatically format your code.

• Integrates with neovim constructs: use formatprg, the setting used by the gq mapping in default vim.
• Asynchronous: neovim won’t hang while the formatting command is running
• Doesn’t replace your code with garbage if the formatting command fails (like gq does)
• Applies the minimum difference required to the buffer. This means that the whole buffer won’t be changed and marks and external marks (used e.g. for diagnostics) will be preserved. This makes formatting less disruptive to your workflow
• Can be configured to trigger automatically on write, per buffer
• No startup cost: call the functions you need when you need them, no need to set up anything at startup.

Getting started

Install this package with your favorite package manager.

Then, you can configure some mappings or user commands to the following functions:

• require("minimal-format").format_with_formatprg(bufnr): format the buffer number bufnr
• require("minimal-format").toggle_autocmd: toggle automatic formatting on write

Setting a Formatter per Language

Just configure formatprg like you normally would to use gq. For instance, it might look like this for C:

if executable('clang-format')
  setlocal formatprg=clang-format\ --assume-filename=a.c
  let b:undo_ftplugin .= ' fp<'
endif

Paste the above snippet in .config/nvim/ftplugin/c.vim. Then when you call require("minimal-format").format_with_formatprg(0), the current buffer will be asynchronously formatted with this command.

Example for Rust, in .config/nvim/ftplugin/rust.lua:

if vim.fn.executable "rustfmt" then
  vim.opt_local.formatprg = "rustfmt -q --emit=stdout"
  local edition = require("cj.rust").find_rust_edition()
  if edition then
    vim.opt_local.formatprg:append(" --edition " .. edition)
  end
  vim.b.undo_ftplugin = vim.b.undo_ftplugin .. "|setl fp<"

  require("minimal-format").enable_autocmd(0)
end

This sets the formatprg setting and enable automatic formatting before writing. Also, dynamically detects the current rust edition and adds formatprg to undo_ftplugin.

Formatters per Language