vim-lint

commit

d6f283fcc74795ec8ce729e555ba7ecc9a1bd2a9

parent

316c19d4d0a52586ac0b446aa39dff93becdc77b

Author

Tobias Bengfort <tobias.bengfort@posteo.de>

Date

2019-02-23 16:06

add README

Diffstat

1 files changed, 36 insertions, 0 deletions

diff --git a/README.md b/README.md

@@ -0,0 +1,36 @@
   -1     1 # vim-lint
   -1     2 
   -1     3 `vim-lint` is a vim plugin that runs the currently open file through a
   -1     4 linter.
   -1     5 
   -1     6 It is much simpler than [syntastic][1]. In fact, the implementation is
   -1     7 basically a simplified version of [vim-flake8][2]. However, much like
   -1     8 syntastic, you can configure `vim-lint` to use many different linters (but only
   -1     9 one per file type).
   -1    10 
   -1    11 [1]: https://github.com/vim-syntastic/syntastic/
   -1    12 [2]: https://github.com/nvie/vim-flake8/
   -1    13 
   -1    14 ## Usage
   -1    15 
   -1    16 Press `<F7>` to run a linter on the current file.
   -1    17 
   -1    18 For most file types you will probably have to install and configure a linter
   -1    19 first:
   -1    20 
   -1    21 ```viml
   -1    22 " ftplugin/python_lint.vim
   -1    23 if executable('flake8')
   -1    24     let g:lint_prg = 'flake8 --ignore=W191,W503'
   -1    25     let g:lint_format = '%f:%l:%c: %m'
   -1    26 endif
   -1    27 ```
   -1    28 
   -1    29 For details about `g:line_format`, see `:help errorformat`.
   -1    30 
   -1    31 To run the linter automatically on save, add the following line to your
   -1    32 `.vimrc` file:
   -1    33 
   -1    34 ```viml
   -1    35 autocmd BufWritePost * call Lint()
   -1    36 ```