README.mdown

   1 vim-flake8
   2 ==========
   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).
   7
   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
  10 (complexity checker).
  11
  12
  13 Installation
  14 ------------
  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.
  19
  20 Usage
  21 -----
  22 1. Open a Python file
  23 2. Press `<F7>` to run `flake8` on it
  24
  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].
  27
  28 If any of `g:flake8_show_in_gutter` or `g:flake8_show_in_file` are set to `1`, call:
  29
  30     call flake8#Flake8UnplaceMarkers()
  31
  32 To remove all markers. No default mapping is provided.
  33
  34 Customization
  35 -------------
  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:
  39
  40     autocmd FileType python map <buffer> <F3> :call Flake8()<CR>
  41
  42 For flake8 configuration options please consult the following page:
  43
  44 http://flake8.pycqa.org/en/latest/user/configuration.html
  45
  46 To customize the location of your flake8 binary, set `g:flake8_cmd`:
  47
  48     let g:flake8_cmd="/opt/strangebin/flake8000"
  49
  50 To customize the location of quick fix window, set `g:flake8_quickfix_location`:
  51
  52     let g:flake8_quickfix_location="topleft"
  53
  54 To customize the height of quick fix window, set `g:flake8_quickfix_height`:
  55
  56     let g:flake8_quickfix_height=7
  57
  58 To customize whether the quickfix window opens, set `g:flake8_show_quickfix`:
  59
  60     let g:flake8_show_quickfix=0  " don't show
  61     let g:flake8_show_quickfix=1  " show (default)
  62
  63 To customize whether the show signs in the gutter, set `g:flake8_show_in_gutter`:
  64
  65     let g:flake8_show_in_gutter=0  " don't show (default)
  66     let g:flake8_show_in_gutter=1  " show
  67
  68 To customize whether the show marks in the file, set `g:flake8_show_in_file`:
  69
  70     let g:flake8_show_in_file=0  " don't show (default)
  71     let g:flake8_show_in_file=1  " show
  72
  73 To customize the number of marks to show, set `g:flake8_max_markers`:
  74
  75     let g:flake8_max_markers=500  " (default)
  76
  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.:
  80
  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
  86
  87 To customize the colors used for markers, define the highlight groups, `Flake8_Error`,
  88 `Flake8_Warning`, `Flake8_PyFlake`, `Flake8_Complexity`, `Flake8_Naming`:
  89
  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
  96
  97 Tips
  98 ----
  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)!):
 102
 103     autocmd BufWritePost *.py call Flake8()
 104
 105 This plugin goes well together with the following plugin:
 106
 107 - [PyUnit](https://github.com/nvie/vim-pyunit) (unit test helper under `<F8>`
 108   and `<F9>`)
 109
 110
 111 Max line lengths
 112 ----------------
 113
 114 One particular customization a lot of people like to make is relaxing the
 115 maximum line length default.  This is a config setting that should be set in
 116 flake8 itself. (vim-flake8 "just" invokes it and deals with showing the output
 117 in Vim's quickfix window.)
 118
 119 To do so, put the following into your `~/.config/flake8` file:
 120
 121     [flake8]
 122     max-line-length = 120
 123
 124
 125 History
 126 -------
 127 1.6: Deprecated configuring flake8 options through Vim settings.  Instead,
 128 advise users to use the `~/.config/flake8` config file.
 129
 130     - Decprecated options:
 131       - `g:flake8_builtins`
 132       - `g:flake8_ignore`
 133       - `g:flake8_max_line_length`
 134       - `g:flake8_max_complexity`
 135
 136     - New options:
 137       - `g:flake8_quickfix_height`
 138
 139 1.5: Added markers and the option to don't show the quickfix window, also split
 140 functions into a autoload file. Added:
 141
 142     - Options:
 143       - `g:flake8_show_quickfix`
 144       - `g:flake8_show_in_gutter`
 145       - `g:flake8_show_in_file`
 146       - `g:flake8_max_markers`
 147       - `flake8_error_marker`
 148       - `flake8_warning_marker`
 149       - `flake8_pyflake_marker`
 150       - `flake8_complexity_marker`
 151       - `flake8_naming_marker`
 152     - Functions:
 153       - `flake8#Flake8UnplaceMarkers()`
 154       - `flake8#Flake8()`
 155     - Highlighting:
 156       - `Flake8_Error`
 157       - `Flake8_Warning`
 158       - `Flake8_Complexity`
 159       - `Flake8_Naming`
 160       - `Flake8_PyFlake`
 161
 162 1.4: Suppress output to stdout.
 163
 164 1.3: Added the following options:
 165
 166     - `g:flake8_builtins="_,apply"`
 167     - `g:flake8_max_complexity=10`
 168
 169 1.2: Added the following options:
 170
 171     - `g:flake8_cmd="/opt/strangebin/flake8000"`
 172     - `g:flake8_max_line_length=120`
 173     - `g:flake8_ignore="E501,W293"`
 174
 175 1.1: Added `g:flake8_ignore` option.
 176
 177 1.0: Initial version.
 178
 179
 180 License
 181 -------
 182
 183 Liberally licensed under BSD terms.