All patches and comments are welcome. Please squash your changes to logical
commits before using git-format-patch and git-send-email to
patches@git.madduck.net.
If you'd read over the Git project's submission guidelines and adhered to them,
I'd be especially grateful.
3 `vim-flake8` is a Vim plugin that runs the currently open file through Flake8,
4 a static syntax and style checker for Python source code. It supersedes both
5 [vim-pyflakes](https://github.com/nvie/vim-pyflakes) and
6 [vim-pep8](https://github.com/nvie/vim-pep8).
8 [Flake8](https://pypi.python.org/pypi/flake8/) is a wrapper around PyFlakes
9 (static syntax checker), PEP8 (style checker) and Ned's MacCabe script
15 Use [vim-pathogen](https://github.com/tpope/vim-pathogen) if you're not using
16 it already. Make sure you've installed the
17 [flake8](https://pypi.python.org/pypi/flake8/) package. Then, simply put the
18 contents of this repository in your `~/.vim/bundle` directory.
23 2. Press `<F7>` to run `flake8` on it
25 It shows the errors inside a quickfix window, which will allow your to quickly
26 jump to the error locations by simply pressing [Enter].
28 If any of `g:flake8_show_in_gutter` or `g:flake8_show_in_file` are set to `1`, call:
30 call flake8#Flake8UnplaceMarkers()
32 To remove all markers. No default mapping is provided.
36 If you don't want to use the `<F7>` key for flake8-checking, simply remap it to
37 another key. It autodetects whether it has been remapped and won't register
38 the `<F7>` key if so. For example, to remap it to `<F3>` instead, use:
40 autocmd FileType python map <buffer> <F3> :call Flake8()<CR>
42 For flake8 configuration options please consult the following page:
44 https://flake8.readthedocs.org/en/latest/config.html
46 To customize the location of your flake8 binary, set `g:flake8_cmd`:
48 let g:flake8_cmd="/opt/strangebin/flake8000"
50 To customize the location of quick fix window, set `g:flake8_quickfix_location`:
52 let g:flake8_quickfix_location="topleft"
54 To customize the height of quick fix window, set `g:flake8_quickfix_height`:
56 let g:flake8_quickfix_height=7
58 To customize whether the quickfix window opens, set `g:flake8_show_quickfix`:
60 let g:flake8_show_quickfix=0 " don't show
61 let g:flake8_show_quickfix=1 " show (default)
63 To customize whether the show signs in the gutter, set `g:flake8_show_in_gutter`:
65 let g:flake8_show_in_gutter=0 " don't show (default)
66 let g:flake8_show_in_gutter=1 " show
68 To customize whether the show marks in the file, set `g:flake8_show_in_file`:
70 let g:flake8_show_in_file=0 " don't show (default)
71 let g:flake8_show_in_file=1 " show
73 To customize the number of marks to show, set `g:flake8_max_markers`:
75 let g:flake8_max_markers=500 " (default)
77 To customize the gutter markers, set any of `flake8_error_marker`, `flake8_warning_marker`,
78 `flake8_pyflake_marker`, `flake8_complexity_marker`, `flake8_naming_marker`. Setting one to
79 the empty string disables it. Ex.:
81 flake8_error_marker='EE' " set error marker to 'EE'
82 flake8_warning_marker='WW' " set warning marker to 'WW'
83 flake8_pyflake_marker='' " disable PyFlakes warnings
84 flake8_complexity_marker='' " disable McCabe complexity warnings
85 flake8_naming_marker='' " disable naming warnings
87 To customize the colors used for markers, define the highlight groups, `Flake8_Error`,
88 `Flake8_Warning`, `Flake8_PyFlake`, `Flake8_Complexity`, `Flake8_Naming`:
90 " to use colors defined in the colorscheme
91 highlight link Flake8_Error Error
92 highlight link Flake8_Warning WarningMsg
93 highlight link Flake8_Complexity WarningMsg
94 highlight link Flake8_Naming WarningMsg
95 highlight link Flake8_PyFlake WarningMsg
99 A tip might be to run the Flake8 check every time you write a Python file, to
100 enable this, add the following line to your `.vimrc` file (thanks
101 [Godefroid](https://github.com/gotcha)!):
103 autocmd BufWritePost *.py call Flake8()
105 This plugin goes well together with the following plugin:
107 - [PyUnit](https://github.com/nvie/vim-pyunit) (unit test helper under `<F8>`
113 1.6: Deprecated configuring flake8 options through Vim settings. Instead,
114 advise users to use the flake8 config file.
116 1.5: Added markers and the option to don't show the quickfix window, also split
117 functions into a autoload file. Added:
120 - `g:flake8_show_quickfix`
121 - `g:flake8_show_in_gutter`
122 - `g:flake8_show_in_file`
123 - `g:flake8_max_markers`
124 - `flake8_error_marker`
125 - `flake8_warning_marker`
126 - `flake8_pyflake_marker`
127 - `flake8_complexity_marker`
128 - `flake8_naming_marker`
130 - `flake8#Flake8UnplaceMarkers()`
135 - `Flake8_Complexity`
139 1.4: Suppress output to stdout.
141 1.3: Added the following options:
143 - `g:flake8_builtins="_,apply"`
144 - `g:flake8_max_complexity=10`
146 1.2: Added the following options:
148 - `g:flake8_cmd="/opt/strangebin/flake8000"`
149 - `g:flake8_max_line_length=120`
150 - `g:flake8_ignore="E501,W293"`
152 1.1: Added `g:flake8_ignore` option.
154 1.0: Initial version.
160 Liberally licensed under BSD terms.