|
bgneal@8
|
1 pyflakes-vim
|
|
bgneal@8
|
2 ============
|
|
bgneal@8
|
3
|
|
bgneal@8
|
4 A Vim plugin for checking Python code on the fly.
|
|
bgneal@8
|
5
|
|
bgneal@8
|
6 PyFlakes catches common Python errors like mistyping a variable name or
|
|
bgneal@8
|
7 accessing a local before it is bound, and also gives warnings for things like
|
|
bgneal@8
|
8 unused imports.
|
|
bgneal@8
|
9
|
|
bgneal@8
|
10 pyflakes-vim uses the output from PyFlakes to highlight errors in your code.
|
|
bgneal@8
|
11 To locate errors quickly, use quickfix_ commands like :cc.
|
|
bgneal@8
|
12
|
|
bgneal@8
|
13 Make sure to check vim.org_ for the latest updates.
|
|
bgneal@8
|
14
|
|
bgneal@8
|
15 .. _pyflakes.vim: http://www.vim.org/scripts/script.php?script_id=2441
|
|
bgneal@8
|
16 .. _vim.org: http://www.vim.org/scripts/script.php?script_id=2441
|
|
bgneal@8
|
17 .. _quickfix: http://vimdoc.sourceforge.net/htmldoc/quickfix.html#quickfix
|
|
bgneal@8
|
18
|
|
bgneal@8
|
19 Quick Installation
|
|
bgneal@8
|
20 ------------------
|
|
bgneal@8
|
21
|
|
bgneal@8
|
22 1. Make sure your ``.vimrc`` has::
|
|
bgneal@8
|
23
|
|
bgneal@8
|
24 filetype on " enables filetype detection
|
|
bgneal@8
|
25 filetype plugin on " enables filetype specific plugins
|
|
bgneal@8
|
26
|
|
bgneal@8
|
27 2. Download the latest release_.
|
|
bgneal@8
|
28
|
|
bgneal@8
|
29 3. If you're using pathogen_, unzip the contents of ``pyflakes-vim.zip`` into
|
|
bgneal@8
|
30 its own bundle directory, i.e. into ``~/.vim/bundle/pyflakes-vim/``.
|
|
bgneal@8
|
31
|
|
bgneal@8
|
32 Otherwise unzip ``pyflakes.vim`` and the ``pyflakes`` directory into
|
|
bgneal@8
|
33 ``~/.vim/ftplugin/python`` (or somewhere similar on your
|
|
bgneal@8
|
34 `runtime path`_ that will be sourced for Python files).
|
|
bgneal@8
|
35
|
|
bgneal@8
|
36 .. _release: http://www.vim.org/scripts/script.php?script_id=2441
|
|
bgneal@8
|
37 .. _pathogen: http://www.vim.org/scripts/script.php?script_id=2332
|
|
bgneal@8
|
38 .. _runtime path: http://vimdoc.sourceforge.net/htmldoc/options.html#'runtimepath'
|
|
bgneal@8
|
39
|
|
bgneal@8
|
40 Running from source
|
|
bgneal@8
|
41 -------------------
|
|
bgneal@8
|
42
|
|
bgneal@8
|
43 If you're running pyflakes-vim "from source," you'll need the PyFlakes library
|
|
bgneal@8
|
44 on your PYTHONPATH somewhere. (It is included in the vim.org zipfile.) I recommend
|
|
bgneal@8
|
45 getting my PyFlakes_ fork, which retains column number information, giving more
|
|
bgneal@8
|
46 specific error locations.
|
|
bgneal@8
|
47
|
|
bgneal@8
|
48 .. _vim.org: http://www.vim.org/scripts/script.php?script_id=2441
|
|
bgneal@8
|
49 .. _PyFlakes: http://github.com/kevinw/pyflakes
|
|
bgneal@8
|
50
|
|
bgneal@8
|
51 Hacking
|
|
bgneal@8
|
52 -------
|
|
bgneal@8
|
53
|
|
bgneal@8
|
54 ::
|
|
bgneal@8
|
55
|
|
bgneal@8
|
56 git clone git://github.com/kevinw/pyflakes-vim.git
|
|
bgneal@8
|
57 cd pyflakes-vim
|
|
bgneal@8
|
58 git clone git://github.com/kevinw/pyflakes.git
|
|
bgneal@8
|
59
|
|
bgneal@8
|
60 Options
|
|
bgneal@8
|
61 -------
|
|
bgneal@8
|
62
|
|
bgneal@8
|
63 Set this option to you vimrc file to disable quickfix support::
|
|
bgneal@8
|
64
|
|
bgneal@8
|
65 let g:pyflakes_use_quickfix = 0
|
|
bgneal@8
|
66
|
|
bgneal@8
|
67 The value is set to 1 by default.
|
|
bgneal@8
|
68
|
|
bgneal@8
|
69 TODO
|
|
bgneal@8
|
70 ----
|
|
bgneal@8
|
71 * signs_ support (show warning and error icons to left of the buffer area)
|
|
bgneal@8
|
72 * configuration variables
|
|
bgneal@8
|
73 * parse or intercept useful output from the warnings module
|
|
bgneal@8
|
74
|
|
bgneal@8
|
75 .. _signs: http://www.vim.org/htmldoc/sign.html
|
|
bgneal@8
|
76
|
|
bgneal@8
|
77 Changelog
|
|
bgneal@8
|
78 ---------
|
|
bgneal@8
|
79
|
|
bgneal@8
|
80 Please see http://www.vim.org/scripts/script.php?script_id=2441 for a history of
|
|
bgneal@8
|
81 all changes.
|
|
bgneal@8
|
82
|
