|
| 1 | +*neoformat.txt* A Neovim plugin for formatting. |
| 2 | + |
| 3 | +Version: 0.1 |
| 4 | + |
| 5 | +CONTENTS *neoformat-contents* |
| 6 | + |
| 7 | +Introduction |neoformat-introduction| |
| 8 | +Install |neoformat-install| |
| 9 | +Usage |neoformat-usage| |
| 10 | +Supported Filetypes |neoformat-supported-filetypes| |
| 11 | + |
| 12 | +============================================================================== |
| 13 | +INTRODUCTION *neoformat-introduction* |
| 14 | + |
| 15 | +*neoformat* uses a variety of formatters for differing filetypes. |
| 16 | +Currently, *neoformat* will run a formatter asynchronously, and on success it |
| 17 | +will update the current buffer with the formatted text. On a formatter failure, |
| 18 | +*neoformat* will try the next formatter defined for the filetype. |
| 19 | + |
| 20 | +The job control is based off of vim-go's. |
| 21 | + |
| 22 | +============================================================================== |
| 23 | +INSTALL *neoformat-install* |
| 24 | + |
| 25 | +Install with [vim-plug](https://github.com/junegunn/vim-plug) |
| 26 | +> |
| 27 | + Plug 'sbdchd/neoformat' |
| 28 | +< |
| 29 | +============================================================================== |
| 30 | +USAGE *neoformat-usage* *Neoformat* |
| 31 | + |
| 32 | +Format the current file using its filetype |
| 33 | +> |
| 34 | + :Neoformat |
| 35 | +< |
| 36 | +Specify a filetype |
| 37 | +> |
| 38 | + :Neoformat python |
| 39 | +< |
| 40 | +Or specify a certain formatter |
| 41 | +> |
| 42 | + :Neoformat javascript/js-beautify |
| 43 | +< |
| 44 | +============================================================================== |
| 45 | +SUPPORTED FILETYPES *neoformat-supported-filetypes* |
| 46 | + |
| 47 | +- Arduino |
| 48 | + - [uncrustify](http://uncrustify.sourceforge.net) |
| 49 | +- C |
| 50 | + - [uncrustify](http://uncrustify.sourceforge.net) |
| 51 | +- C# |
| 52 | + - [uncrustify](http://uncrustify.sourceforge.net) |
| 53 | +- C++ |
| 54 | + - [uncrustify](http://uncrustify.sourceforge.net) |
| 55 | +- CSS |
| 56 | + - css-beautify (ships with [js-beautify](https://github.com/beautify-web/js-beautify)) |
| 57 | +- D |
| 58 | + - [uncrustify](http://uncrustify.sourceforge.net), [dfmt](https://github.com/Hackerpilot/dfmt) |
| 59 | +- Elm |
| 60 | + - [elm-format](https://github.com/avh4/elm-format) |
| 61 | +- Go |
| 62 | + - [gofmt](https://golang.org/cmd/gofmt/), [goimports](https://godoc.org/golang.org/x/tools/cmd/goimports) |
| 63 | +- Haskell |
| 64 | + - [stylish-haskell](https://github.com/jaspervdj/stylish-haskell) |
| 65 | +- HTML |
| 66 | + - html-beautify (ships with [js-beautify](https://github.com/beautify-web/js-beautify)) |
| 67 | +- Jade |
| 68 | + - [pug-beautifier](https://github.com/vingorius/pug-beautifier) |
| 69 | +- Java |
| 70 | + - [uncrustify](http://uncrustify.sourceforge.net) |
| 71 | +- Javascript |
| 72 | + - [js-beautify](https://github.com/beautify-web/js-beautify) |
| 73 | +- JSON |
| 74 | + - [js-beautify](https://github.com/beautify-web/js-beautify) |
| 75 | +- Markdown |
| 76 | + - [remark](https://github.com/wooorm/remark) |
| 77 | +- Objective-C |
| 78 | + - [uncrustify](http://uncrustify.sourceforge.net) |
| 79 | +- Pawn |
| 80 | + - [uncrustify](http://uncrustify.sourceforge.net) |
| 81 | +- Perl |
| 82 | + - [perltidy](http://perltidy.sourceforge.net) |
| 83 | +- Pug (formally Jade) |
| 84 | + - [pug-beautifier](https://github.com/vingorius/pug-beautifier) |
| 85 | +- Python |
| 86 | + - [yapf](https://github.com/google/yapf), [autopep8](https://github.com/hhatto/autopep8) |
| 87 | +- Ruby |
| 88 | + - [ruby-beautify](https://github.com/erniebrodeur/ruby-beautify) |
| 89 | +- SASS |
| 90 | + - [sass-convert](http://sass-lang.com/documentation/#executables) |
| 91 | +- SCSS |
| 92 | + - [sass-convert](http://sass-lang.com/documentation/#executables) |
| 93 | +- SQL |
| 94 | + - sqlformat (ships with [sqlparse](https://github.com/andialbrecht/sqlparse)) |
| 95 | +- Typescript |
| 96 | + - [tsfmt](https://github.com/vvakame/typescript-formatter) |
| 97 | +- VALA |
| 98 | + - [uncrustify](http://uncrustify.sourceforge.net) |
| 99 | +- XHTML |
| 100 | + - [tidy](http://www.html-tidy.org) |
| 101 | +- XML |
| 102 | + - [tidy](http://www.html-tidy.org) |
| 103 | + |
| 104 | +============================================================================== |
| 105 | +vim:tw=78:ts=8:ft=help:norl:noet:fen:noet: |
0 commit comments