Neoformat

A Neovim plugin for formatting code.

Neoformat uses a variety of formatters for differing filetypes. Currently, Neoformat will run a formatter asynchronously, and on success it will update the current buffer with the formatted text. On a formatter failure, Neoformat will try the next formatter defined for the filetype.

The job control is based off of vim-go's.

Basic Usage

Format the current file using its filetype

:Neoformat

Or specify a filetype

:Neoformat python

Current Limitation(s)

In order to preserve marks, jumps, etc., Neoformat uses Vim's setline() function to insert the formatted text. If the buffer is changed before the formatter has completed, then the updated text will be put into the current buffer.

To prevent this, format jobs are cancelled when changing / closing the buffer.

So don't switch buffers before the the formatting is complete!

Config [Optional]

Define custom formatters.

let g:neoformat_python_autopep8 = {
            \ 'exe': 'autopep8'
            \ }

let g:neoformat_enabled_python = ['autopep8']

Enable basic formatting when a filetype is not found. Disabled by default.

" Enable alignment
let g:neoformat_basic_format_align = 1

" Enable tab to spaces conversion
let g:neoformat_basic_format_retab = 1

" Enable trimmming of trailing whitespace
let g:neoformat_basic_format_trim = 1

Supported Filetypes

• C
  • uncrustify
• C#
  • uncrustify
• C++
  • uncrustify
• CSS
  • css-beautify
• D
  • uncrustify, dfmt
• Elm
  • elm-format
• Go
  • gofmt, goimports
• Haskell
  • stylish-haskell
• HTML
  • html-beautify
• Jade
  • pug-beautifier
• Java
  • uncrustify
• Javascript
  • js-beautify
• JSON
  • js-beautify
• Markdown
  • remark
• Objective-C
  • uncrustify
• Pawn
  • uncrustify
• Pug (formally Jade)
  • pug-beautifier
• Python
  • yapf, autopep8
• Ruby
  • ruby-beautify
• SASS
  • sass-convert
• SCSS
  • sass-convert
• SQL
  • sqlformat (ships with sqlparse)
• Typescript
  • tsfmt
• VALA
  • uncrustify
• XHTML
  • tidy
• XML
  • tidy