X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/cb3a235fdfba6a9703172c9693a9bd0f89897279..da271f592566b3b8aa6d79ec0ef7b18f149dd3fd:/README.mdown?ds=inline diff --git a/README.mdown b/README.mdown index abfb72c..b7472b8 100644 --- a/README.mdown +++ b/README.mdown @@ -5,17 +5,17 @@ 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](http://pypi.python.org/pypi/flake8/) is a wrapper around PyFlakes -(static syntax checker), PEP8 (style checker) -and Ned's MacCabe script (complexity checker). +[Flake8](https://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. 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. +it already. Make sure you've installed the +[flake8](https://pypi.python.org/pypi/flake8/) package. Then, simply put the +contents of this repository in your `~/.vim/bundle` directory. Usage ----- @@ -39,21 +39,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: +For flake8 configuration options please consult the following page: - let g:flake8_builtins="_,apply" - -To ignore errors, in your .vimrc: - - let g:flake8_ignore="E501,W293" - -If you want to change the max line length for PEP8: - - let g:flake8_max_line_length=99 - -To set the maximum [McCabe complexity](https://en.wikipedia.org/wiki/Cyclomatic_complexity) before a warning is issued: - - let g:flake8_max_complexity=10 +https://flake8.readthedocs.org/en/latest/config.html To customize the location of your flake8 binary, set `g:flake8_cmd`: @@ -92,7 +80,7 @@ the empty string disables it. Ex.: flake8_complexity_marker='' " disable McCabe complexity warnings flake8_naming_marker='' " disable naming warnings -To customize the colors used for markers, define the highligth groups, `Flake8_Error`, +To customize the colors used for markers, define the highlight groups, `Flake8_Error`, `Flake8_Warning`, `Flake8_PyFlake`, `Flake8_Complexity`, `Flake8_Naming`: " to use colors defined in the colorscheme @@ -106,13 +94,13 @@ 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)!): +[Godefroid](https://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 `` +- [PyUnit](https://github.com/nvie/vim-pyunit) (unit test helper under `` and ``)