mhartington/formatter.nvim

github github
formatting plugin
star 348
stars
alert-circle 11
open issues
users 7
subscribers
git-branch 34
forks
CREATED

2020-09-14

UPDATED

last month

packer

require('packer').startup(function()
  use 'mhartington/formatter.nvim'
end)

paq

require "paq" { 
  'mhartington/formatter.nvim'
}

Formatter.nvim

WIP

A format runner for neovim, written in lua.

Install

Using your package manager of choice

" vim-plug
Plug 'mhartington/formatter.nvim'

" dein.nvim
call dein#add('mhartington/formatter.nvim')


" configure the plugin

lua require('formatter').setup(...)
" Provided by setup function
nnoremap <silent> <leader>f :Format<CR>

Configure

By default there are no tools configured. This may change. To config a tool, you can create a table for the filetype and tool you want to use

If you would like to see a list of some common formatters and how to configure them, checkout ./CONFIG.md.

Each format tool config is a function that returns a table. Since each entry is a function, the tables for each file type act as an ordered list (or array). This mean things will run in the order you list them, keep this in mind.

Each formatter should return a table that consist of:

  • exe: the program you wish to run
  • args: a table of args to pass
  • stdin: If it should use stdin or not.
  • cwd : The path to run the program from.
  • ignore_exitcode : Set to true if the program expects non-zero success exit code (optional)
  • tempfile_dir: directory for temp file when not using stdin (optional)
  • tempfile_prefix: prefix for temp file when not using stdin (optional)
  • tempfile_postfix: postfix for temp file when not using stdin (optional)

cwd

The cwd argument can be used for e.g. monolithic projects which contain sources with different styles. Setting cwd to the path of the file being formatted will cause e.g. clang-format to search for the nearest .clang-format file in the file's parent directories.

Format on save

To enable format on save, you can create a autocmd to trigger the formater using FormatWrite, which will format and write to the current saved file.

vim.api.nvim_exec([[
augroup FormatAutogroup
  autocmd!
  autocmd BufWritePost *.js,*.rs,*.lua FormatWrite
augroup END
]], true)