]>
git.madduck.net Git - etc/vim.git/blobdiff - README.mdown
madduck's git repository
Every one of the projects in this repository is available at the canonical
URL git://git.madduck.net/madduck/pub/<projectpath> — see
each project's metadata for the exact URL.
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.
SSH access, as well as push access can be individually
arranged .
If you use my repositories frequently, consider adding the following
snippet to ~/.gitconfig and using the third clone URL listed for each
project:
[url "git://git.madduck.net/madduck/"]
insteadOf = madduck:
[vim-pyflakes](https://github.com/nvie/vim-pyflakes) and
[vim-pep8](https://github.com/nvie/vim-pep8).
[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
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
`~/.vim/bundle` directory.
Usage
autocmd FileType python map <buffer> <F3> :call Flake8()<CR>
autocmd FileType python map <buffer> <F3> :call Flake8()<CR>
-
-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()
-
To ignore errors, in your .vimrc:
let g:flake8_ignore="E501,W293"
To ignore errors, in your .vimrc:
let g:flake8_ignore="E501,W293"
let g:flake8_max_line_length=99
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
+
To cutomize the location of your flake8 binary, set `g:flake8_cmd`:
let g:flake8_cmd="/opt/strangebin/flake8000"
To cutomize the location of your flake8 binary, set `g:flake8_cmd`:
let g:flake8_cmd="/opt/strangebin/flake8000"
+
+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 `<F8>`
This plugin goes well together with the following plugin:
- [PyUnit](http://github.com/nvie/vim-pyunit) (unit test helper under `<F8>`