syntastic/syntax_checkers/python/flake8.vim

"============================================================================
"File:        flake8.vim
"Description: Syntax checking plugin for syntastic
"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

let s:save_cpo = &cpo
set cpo&vim

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

function! SyntaxCheckers_python_flake8_GetLocList() dict
    let makeprg = self.makeprgBuild({})

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

    let env = syntastic#util#isRunningWindows() ? {} : { 'TERM': 'dumb' }

    let loclist = SyntasticMake({
        \ 'makeprg': makeprg,
        \ 'errorformat': errorformat,
        \ 'env': env })

    for e in loclist
        " E*** and W*** are pep8 errors
        " F*** are PyFlakes codes
        " C*** are McCabe complexity messages
        " N*** are naming conventions from pep8-naming
        " H*** are OpenStack messages

        if has_key(e, 'nr')
            let e['text'] .= printf(' [%s%03d]', e['type'], e['nr'])
            " E901 are syntax errors
            " E902 are I/O errors
            if e['type'] ==? 'E' && e['nr'] !~# '\m^9'
                let e['subtype'] = 'Style'
            endif
            call remove(e, 'nr')
        endif

        if e['type'] =~? '\m^[CHNW]'
            let e['subtype'] = 'Style'
        endif

        let e['type'] = e['type'] =~? '\m^[EFHC]' ? 'E' : 'W'
    endfor

    return loclist
endfunction

runtime! syntax_checkers/python/pyflakes.vim

call g:SyntasticRegistry.CreateAndRegisterChecker({
    \ 'filetype': 'python',
    \ 'name': 'flake8'})

let &cpo = s:save_cpo
unlet s:save_cpo

" vim: set sw=4 sts=4 et fdm=marker:
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`
Cosmetic cleanup. 2017-09-15 14:04:16 -04:00			`"Description: Syntax checking plugin for syntastic`
split python checker out into 3 files previously there were 3 checkers in the one file 2012-02-20 05:20:48 -05:00			`"Authors: Sylvain Soliman <Sylvain dot Soliman+git at gmail dot com>`
			`" kstep <me@kstep.me>`
			`"`
			`"============================================================================`
Minor cleanup: &cpo guards and formatting. 2014-01-03 04:29:08 -05:00
Cleanup: shut up most vint warnings. 2015-03-25 12:44:34 -04:00			`if exists('g:loaded_syntastic_python_flake8_checker')`
add guards to all checkers goddamn I love macros 2013-02-21 10:50:41 -05:00			`finish`
			`endif`
Minor cleanup: &cpo guards and formatting. 2014-01-03 04:29:08 -05:00			`let g:loaded_syntastic_python_flake8_checker = 1`

			`let s:save_cpo = &cpo`
			`set cpo&vim`
add guards to all checkers goddamn I love macros 2013-02-21 10:50:41 -05:00
Minor cleanup: &cpo guards and formatting. 2014-01-03 04:29:08 -05:00			`function! SyntaxCheckers_python_flake8_GetHighlightRegex(item)`
			`return SyntaxCheckers_python_pyflakes_GetHighlightRegex(a:item)`
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`
New option for SyntasticMake(): env. Setting environment variables by prefixing commands with 'VARIABLE=value' doesn't work under csh. Solution: let Vim set the environment variables. 2014-07-07 12:04:22 -04:00			`let makeprg = self.makeprgBuild({})`
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^,' .`
Checker flake8: allow OpenStack conventions. 2017-08-31 14:19:06 -04:00			`\ '%A%f:%l:%c: %t%n: %m,' .`
Rework of message decoding for flake8. 2014-01-04 03:01:16 -05:00			`\ '%A%f:%l:%c: %t%n %m,' .`
Checker flake8: allow OpenStack conventions. 2017-08-31 14:19:06 -04:00			`\ '%A%f:%l: %t%n: %m,' .`
Rework of message decoding for flake8. 2014-01-04 03:01:16 -05:00			`\ '%A%f:%l: %t%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
New option for SyntasticMake(): env. Setting environment variables by prefixing commands with 'VARIABLE=value' doesn't work under csh. Solution: let Vim set the environment variables. 2014-07-07 12:04:22 -04:00			`let env = syntastic#util#isRunningWindows() ? {} : { 'TERM': 'dumb' }`

Rework of message decoding for flake8. 2014-01-04 03:01:16 -05:00			`let loclist = SyntasticMake({`
Make syntastic#makeprg#build() aware of filetypes. Fixes #667. 2013-05-31 14:05:45 -04:00			`\ 'makeprg': makeprg,`
New option for SyntasticMake(): env. Setting environment variables by prefixing commands with 'VARIABLE=value' doesn't work under csh. Solution: let Vim set the environment variables. 2014-07-07 12:04:22 -04:00			`\ 'errorformat': errorformat,`
			`\ 'env': env })`
Rework of message decoding for flake8. 2014-01-04 03:01:16 -05:00
			`for e in loclist`
			`" E* and W* are pep8 errors`
			`" F*** are PyFlakes codes`
			`" C*** are McCabe complexity messages`
			`" N*** are naming conventions from pep8-naming`
Checker flake8: update comments. 2017-09-01 00:51:15 -04:00			`" H*** are OpenStack messages`
Rework of message decoding for flake8. 2014-01-04 03:01:16 -05:00
			`if has_key(e, 'nr')`
			`let e['text'] .= printf(' [%s%03d]', e['type'], e['nr'])`
			`" E901 are syntax errors`
			`" E902 are I/O errors`
Cleanup: case-sensitive comparisons. 2015-02-23 10:09:00 -05:00			`if e['type'] ==? 'E' && e['nr'] !~# '\m^9'`
Rework of message decoding for flake8. 2014-01-04 03:01:16 -05:00			`let e['subtype'] = 'Style'`
			`endif`
			`call remove(e, 'nr')`
			`endif`

Checker flake8: allow OpenStack conventions. 2017-08-31 14:19:06 -04:00			`if e['type'] =~? '\m^[CHNW]'`
Rework of message decoding for flake8. 2014-01-04 03:01:16 -05:00			`let e['subtype'] = 'Style'`
			`endif`

Checker flake8: allow OpenStack conventions. 2017-08-31 14:19:06 -04:00			`let e['type'] = e['type'] =~? '\m^[EFHC]' ? 'E' : 'W'`
Rework of message decoding for flake8. 2014-01-04 03:01:16 -05:00			`endfor`

			`return loclist`
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'})`
Minor cleanup: &cpo guards and formatting. 2014-01-03 04:29:08 -05:00
			`let &cpo = s:save_cpo`
			`unlet s:save_cpo`

Formatting: folding. 2015-01-04 05:46:54 -05:00			`" vim: set sw=4 sts=4 et fdm=marker:`