X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/0bb2f696f2e934c5549a127a989fe7984275df67..cb3a235fdfba6a9703172c9693a9bd0f89897279:/README.mdown?ds=inline diff --git a/README.mdown b/README.mdown index 5d87dc0..abfb72c 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 @@ -23,6 +25,11 @@ Usage It shows the errors inside a quickfix window, which will allow your to quickly jump to the error locations by simply pressing [Enter]. +If any of `g:flake8_show_in_gutter` or `g:flake8_show_in_file` are set to `1`, call: + + call flake8#Flake8UnplaceMarkers() + +To remove all markers. No default mapping is provided. Customization ------------- @@ -32,14 +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: -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 +51,116 @@ 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" + +To customize whether the quickfix window opens, set `g:flake8_show_quickfix`: + + let g:flake8_show_quickfix=0 " don't show + let g:flake8_show_quickfix=1 " show (default) + +To customize whether the show signs in the gutter, set `g:flake8_show_in_gutter`: + + let g:flake8_show_in_gutter=0 " don't show (default) + let g:flake8_show_in_gutter=1 " show + +To customize whether the show marks in the file, set `g:flake8_show_in_file`: + + let g:flake8_show_in_file=0 " don't show (default) + let g:flake8_show_in_file=1 " show + +To customize the number of marks to show, set `g:flake8_max_markers`: + + let g:flake8_max_markers=500 " (default) + +To customize the gutter markers, set any of `flake8_error_marker`, `flake8_warning_marker`, +`flake8_pyflake_marker`, `flake8_complexity_marker`, `flake8_naming_marker`. Setting one to +the empty string disables it. Ex.: + + flake8_error_marker='EE' " set error marker to 'EE' + flake8_warning_marker='WW' " set warning marker to 'WW' + flake8_pyflake_marker='' " disable PyFlakes warnings + 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`, +`Flake8_Warning`, `Flake8_PyFlake`, `Flake8_Complexity`, `Flake8_Naming`: + + " to use colors defined in the colorscheme + highlight link Flake8_Error Error + highlight link Flake8_Warning WarningMsg + highlight link Flake8_Complexity WarningMsg + highlight link Flake8_Naming WarningMsg + highlight link Flake8_PyFlake WarningMsg + +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.5: Added markers and the option to don't show the quickfix window, also split functions into +a autoload file. Added: + + - Options: + - `g:flake8_show_quickfix` + - `g:flake8_show_in_gutter` + - `g:flake8_show_in_file` + - `g:flake8_max_markers` + - `flake8_error_marker` + - `flake8_warning_marker` + - `flake8_pyflake_marker` + - `flake8_complexity_marker` + - `flake8_naming_marker` + - Functions: + - `flake8#Flake8UnplaceMarkers()` + - `flake8#Flake8()` + - Highlighting: + - `Flake8_Error` + - `Flake8_Warning` + - `Flake8_Complexity` + - `Flake8_Naming` + - `Flake8_PyFlake` + +1.4: Suppress output to stdout. + +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. + + +License +------- + +Liberally licensed under BSD terms.