X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/0bb2f696f2e934c5549a127a989fe7984275df67..293613dbe731a2875ce93739e7b64ee504d8bbab:/README.mdown diff --git a/README.mdown b/README.mdown index 5d87dc0..4db8b3b 100644 --- a/README.mdown +++ b/README.mdown @@ -5,14 +5,16 @@ a static syntax and style checker for Python source code. It supersedes both [vim-pyflakes](https://github.com/nvie/vim-pyflakes) and [vim-pep8](https://github.com/nvie/vim-pep8). -Flake8 is a wrapper around PyFlakes (static syntax checker), PEP8 (style -checker) and Ned's MacCabe script (complexity checker). +[Flake8](http://pypi.python.org/pypi/flake8/) is a wrapper around PyFlakes +(static syntax checker), PEP8 (style checker) +and Ned's MacCabe script (complexity checker). Installation ------------ Use [vim-pathogen](https://github.com/tpope/vim-pathogen) if you're not using -it already. Then, simply put the contents of this repository in your +it already. Make sure you've installed the [flake8](http://pypi.python.org/pypi/flake8/) package. +Then, simply put the contents of this repository in your `~/.vim/bundle` directory. Usage @@ -32,14 +34,9 @@ the `` key if so. For example, to remap it to `` instead, use: autocmd FileType python map :call Flake8() +To add builtins, in your .vimrc: -Tips ----- -A tip might be to run the Flake8 check every time you write a Python file, to -enable this, add the following line to your `.vimrc` file (thanks -[Godefroid](http://github.com/gotcha)!): - - autocmd BufWritePost *.py call Flake8() + let g:flake8_builtins="_,apply" To ignore errors, in your .vimrc: @@ -49,11 +46,46 @@ If you want to change the max line length for PEP8: let g:flake8_max_line_length=99 -To cutomize the location of your flake8 binary, set `g:flake8_cmd`: +To set the maximum [McCabe complexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity) before a warning is issued: + + let g:flake8_max_complexity=10 + +To customize the location of your flake8 binary, set `g:flake8_cmd`: let g:flake8_cmd="/opt/strangebin/flake8000" +To customize the location of quick fix window, set `g:flake8_quickfix_location`: + + let g:flake8_quickfix_location="topleft" + +Tips +---- +A tip might be to run the Flake8 check every time you write a Python file, to +enable this, add the following line to your `.vimrc` file (thanks +[Godefroid](http://github.com/gotcha)!): + + autocmd BufWritePost *.py call Flake8() + This plugin goes well together with the following plugin: - [PyUnit](http://github.com/nvie/vim-pyunit) (unit test helper under `` and ``) + + +History +------- + +1.3: Added the following options: + + - `g:flake8_builtins="_,apply"` + - `g:flake8_max_complexity=10` + +1.2: Added the following options: + + - `g:flake8_cmd="/opt/strangebin/flake8000"` + - `g:flake8_max_line_length=120` + - `g:flake8_ignore="E501,W293"` + +1.1: Added `g:flake8_ignore` option. + +1.0: Initial version.