syntastic/syntax_checkers/python/flake8.vim

"============================================================================
"File:        flake8.vim
"Description: Syntax checking plugin for syntastic.vim
"Authors:     Sylvain Soliman <Sylvain dot Soliman+git at gmail dot com>
"             kstep <me@kstep.me>
"
"============================================================================
if exists("g:loaded_syntastic_python_flake8_checker")
    finish
endif
let g:loaded_syntastic_python_flake8_checker=1

function! SyntaxCheckers_python_flake8_GetHighlightRegex(i)
    return SyntaxCheckers_python_pyflakes_GetHighlightRegex(a:i)
endfunction

function! SyntaxCheckers_python_flake8_GetLocList() dict
    let makeprg = syntastic#makeprg#build({
        \ 'exe': 'flake8',
        \ 'checker': self })

    let errorformat =
        \ '%E%f:%l: could not compile,%-Z%p^,' .
        \ '%E%f:%l:%c: F%n %m,' .
        \ '%W%f:%l:%c: C%n %m,' .
        \ '%W%f:%l:%c: %.%n %m,' .
        \ '%W%f:%l: %.%n %m,' .
        \ '%-G%.%#'

    return SyntasticMake({
        \ 'makeprg': makeprg,
        \ 'errorformat': errorformat })
endfunction

runtime! syntax_checkers/python/pyflakes.vim

call g:SyntasticRegistry.CreateAndRegisterChecker({
    \ 'filetype': 'python',
    \ 'name': 'flake8'})
split python checker out into 3 files previously there were 3 checkers in the one file 2012-02-20 05:20:48 -05:00			`"============================================================================`
			`"File: flake8.vim`
			`"Description: Syntax checking plugin for syntastic.vim`
			`"Authors: Sylvain Soliman <Sylvain dot Soliman+git at gmail dot com>`
			`" kstep <me@kstep.me>`
			`"`
			`"============================================================================`
add guards to all checkers goddamn I love macros 2013-02-21 10:50:41 -05:00			`if exists("g:loaded_syntastic_python_flake8_checker")`
			`finish`
			`endif`
			`let g:loaded_syntastic_python_flake8_checker=1`

refactor how we represent and store checkers using python as a demo Add 2 classes: SyntasticChecker and SyntasticRegistry. SyntasticChecker represents a checker. It holds funcrefs to the checker func, the highlight regex func and a new `isAvailable()` func (that essentially just checks if the checker exe is installed) SyntasticRegistry is responsible for: * loading checkers * storing checkers * fetching the checkers to use according to availability and the users settings Motivation/benefits: * in the current system only one checker can be loaded per filetype * syntax checkers cant be "chained" together * the system is hard to add features to since fundamental concepts like syntax checkers and location lists arent represented explicitly Things left to do: * add a call to g:SyntasticRegistry.CreateAndRegisterChecker() to all checkers * add an `isAvailable` function to all checkers * move all checkers into `syntax_checkers/filetype/checkername.vim` - g:SyntasticRegistry assumes this layout, and its a good idea anyway for consistency and it makes it easier for users to add their own checkers Things to do after all of the above: * add a LocationList class and move all the filtering functions onto it * possibly add an Error class that wraps up each item in a loc list Random notes: * with the new system you can select the checkers to use with e.g. `let g:syntastic_python_checkers=['flake8', 'pylint']` This will try flake8 first, and if no errors are detected it will move onto pylint. 2013-01-23 19:01:30 -05:00			`function! SyntaxCheckers_python_flake8_GetHighlightRegex(i)`
Pylama: new checker for Python 2. Minor refactoring. 2013-07-14 12:13:18 -04:00			`return SyntaxCheckers_python_pyflakes_GetHighlightRegex(a:i)`
split python checker out into 3 files previously there were 3 checkers in the one file 2012-02-20 05:20:48 -05:00			`endfunction`

Registry cleanup, stage 1. Make SyntaxCheckers_*_GetLocList() dictionary functions. Pass a reference to the current checker to syntastic#makeprg#build(). Add an optional 'redirect' argument to CreateAndRegisterChecker(). Change the sh checker to use the new dictionary functions. Add a new registry method getLocListRaw() (needed for the sh checker). 2013-10-28 07:53:33 -04:00			`function! SyntaxCheckers_python_flake8_GetLocList() dict`
add a makeprg builder The problem --- Some people want to change the syntax checker args and/or executable. Currently they have to create their own checker to do this. Solution --- Create a standard API for building a makeprg that allows users to set global variables to override the exe or args. This API is in use in the coffee and python/flake8 checkers - as proofs of concept. So, if the user wanted to change the args that get passed to `flake8` they can now set `let g:syntastic_python_flake8_args="--foo --bar"` in their vimrc. Similarly they could set `let g:syntastic_python_flake8_exe='python foo.py'` 2012-12-16 13:28:08 -05:00			`let makeprg = syntastic#makeprg#build({`
Make syntastic#makeprg#build() aware of filetypes. Fixes #667. 2013-05-31 14:05:45 -04:00			`\ 'exe': 'flake8',`
Registry cleanup, stage 1. Make SyntaxCheckers_*_GetLocList() dictionary functions. Pass a reference to the current checker to syntastic#makeprg#build(). Add an optional 'redirect' argument to CreateAndRegisterChecker(). Change the sh checker to use the new dictionary functions. Add a new registry method getLocListRaw() (needed for the sh checker). 2013-10-28 07:53:33 -04:00			`\ 'checker': self })`
Make syntastic#makeprg#build() aware of filetypes. Fixes #667. 2013-05-31 14:05:45 -04:00
break down some error format strings Most errorformats are now expressed 1 "clause" per line. 2013-05-14 12:36:20 -04:00			`let errorformat =`
Tune flake8 error levels. 2013-09-19 18:45:58 -04:00			`\ '%E%f:%l: could not compile,%-Z%p^,' .`
			`\ '%E%f:%l:%c: F%n %m,' .`
			`\ '%W%f:%l:%c: C%n %m,' .`
			`\ '%W%f:%l:%c: %.%n %m,' .`
			`\ '%W%f:%l: %.%n %m,' .`
break down some error format strings Most errorformats are now expressed 1 "clause" per line. 2013-05-14 12:36:20 -04:00			`\ '%-G%.%#'`
Make syntastic#makeprg#build() aware of filetypes. Fixes #667. 2013-05-31 14:05:45 -04:00
			`return SyntasticMake({`
			`\ 'makeprg': makeprg,`
			`\ 'errorformat': errorformat })`
split python checker out into 3 files previously there were 3 checkers in the one file 2012-02-20 05:20:48 -05:00			`endfunction`
refactor how we represent and store checkers using python as a demo Add 2 classes: SyntasticChecker and SyntasticRegistry. SyntasticChecker represents a checker. It holds funcrefs to the checker func, the highlight regex func and a new `isAvailable()` func (that essentially just checks if the checker exe is installed) SyntasticRegistry is responsible for: * loading checkers * storing checkers * fetching the checkers to use according to availability and the users settings Motivation/benefits: * in the current system only one checker can be loaded per filetype * syntax checkers cant be "chained" together * the system is hard to add features to since fundamental concepts like syntax checkers and location lists arent represented explicitly Things left to do: * add a call to g:SyntasticRegistry.CreateAndRegisterChecker() to all checkers * add an `isAvailable` function to all checkers * move all checkers into `syntax_checkers/filetype/checkername.vim` - g:SyntasticRegistry assumes this layout, and its a good idea anyway for consistency and it makes it easier for users to add their own checkers Things to do after all of the above: * add a LocationList class and move all the filtering functions onto it * possibly add an Error class that wraps up each item in a loc list Random notes: * with the new system you can select the checkers to use with e.g. `let g:syntastic_python_checkers=['flake8', 'pylint']` This will try flake8 first, and if no errors are detected it will move onto pylint. 2013-01-23 19:01:30 -05:00
Registry cleanup, stage 2. (1) Checkers now have an _exec attribute, and an accessor getExec(). (2) CreateAndRegisterChecker() initializes _exec from an optional argument 'exec'. If this argument is missing, 'name' is used instead. (3) Functions SyntaxCheckers__IsAvailable() are now dictionary functions. (4) Functions SyntaxCheckers__IsAvailable() are now optional. When they are missing, they are assumed to return executable(expand(self.getExec())). (5) Argument 'exe' of function syntastic#makeprg#build() is now optional. If this argument is missing, expand(self.getExec()) is used to set checker executables. 2013-10-28 11:30:25 -04:00			`runtime! syntax_checkers/python/pyflakes.vim`

refactor how we represent and store checkers using python as a demo Add 2 classes: SyntasticChecker and SyntasticRegistry. SyntasticChecker represents a checker. It holds funcrefs to the checker func, the highlight regex func and a new `isAvailable()` func (that essentially just checks if the checker exe is installed) SyntasticRegistry is responsible for: * loading checkers * storing checkers * fetching the checkers to use according to availability and the users settings Motivation/benefits: * in the current system only one checker can be loaded per filetype * syntax checkers cant be "chained" together * the system is hard to add features to since fundamental concepts like syntax checkers and location lists arent represented explicitly Things left to do: * add a call to g:SyntasticRegistry.CreateAndRegisterChecker() to all checkers * add an `isAvailable` function to all checkers * move all checkers into `syntax_checkers/filetype/checkername.vim` - g:SyntasticRegistry assumes this layout, and its a good idea anyway for consistency and it makes it easier for users to add their own checkers Things to do after all of the above: * add a LocationList class and move all the filtering functions onto it * possibly add an Error class that wraps up each item in a loc list Random notes: * with the new system you can select the checkers to use with e.g. `let g:syntastic_python_checkers=['flake8', 'pylint']` This will try flake8 first, and if no errors are detected it will move onto pylint. 2013-01-23 19:01:30 -05:00			`call g:SyntasticRegistry.CreateAndRegisterChecker({`
			`\ 'filetype': 'python',`
refactor all the syntax checkers to use the new API and dir layout 2013-01-27 15:08:30 -05:00			`\ 'name': 'flake8'})`