function! flake8#Flake8()
call s:Flake8()
+ call s:Warnings()
endfunction
function! flake8#Flake8UnplaceMarkers()
call s:UnplaceMarkers()
+ call s:Warnings()
+endfunction
+
+function! flake8#Flake8ShowError()
+ call s:ShowErrorMessage()
endfunction
"" }}}
"" ** internal ** {{{
+"" warnings
+
+let s:displayed_warnings = 0
+function s:Warnings()
+ if !s:displayed_warnings
+ let l:show_website_url = 0
+
+ let l:msg = "has been deprecated in favour of flake8 config files"
+ for setting_name in ['g:flake8_ignore', 'g:flake8_builtins', 'g:flake8_max_line_length', 'g:flake8_max_complexity']
+ if exists(setting_name)
+ echohl WarningMsg | echom setting_name l:msg | echohl None
+ let l:show_website_url = 1
+ endif
+ endfor
+
+ if l:show_website_url
+ let l:url = "http://flake8.readthedocs.org/en/latest/config.html"
+ echohl WarningMsg | echom l:url | echohl None
+ endif
+ let s:displayed_warnings = 1
+ endif
+endfunction
+
"" config
function! s:DeclareOption(name, globalPrefix, default) " {{{
" flake8 command
call s:DeclareOption('flake8_cmd', '', '"flake8"')
- " flake8 stuff
- call s:DeclareOption('flake8_builtins', ' --builtins=', '')
- call s:DeclareOption('flake8_ignore', ' --ignore=', '')
- call s:DeclareOption('flake8_max_line_length', ' --max-line-length=', '')
- call s:DeclareOption('flake8_max_complexity', ' --max-complexity=', '')
" quickfix
call s:DeclareOption('flake8_quickfix_location', '', '"belowright"')
- call s:DeclareOption('flake8_quickfix_height', '', 5)
- call s:DeclareOption('flake8_show_quickfix', '', 1)
+ call s:DeclareOption('flake8_quickfix_height', '', 5)
+ call s:DeclareOption('flake8_show_quickfix', '', 1)
" markers to show
call s:DeclareOption('flake8_show_in_gutter', '', 0)
- call s:DeclareOption('flake8_show_in_file', '', 0)
- call s:DeclareOption('flake8_max_markers', '', 500)
+ call s:DeclareOption('flake8_show_in_file', '', 0)
+ call s:DeclareOption('flake8_max_markers', '', 500)
" marker signs
- call s:DeclareOption('flake8_error_marker', '', '"E>"')
- call s:DeclareOption('flake8_warning_marker', '', '"W>"')
- call s:DeclareOption('flake8_pyflake_marker', '', '"F>"')
+ call s:DeclareOption('flake8_error_marker', '', '"E>"')
+ call s:DeclareOption('flake8_warning_marker', '', '"W>"')
+ call s:DeclareOption('flake8_pyflake_marker', '', '"F>"')
call s:DeclareOption('flake8_complexity_marker', '', '"C>"')
- call s:DeclareOption('flake8_naming_marker', '', '"N>"')
+ call s:DeclareOption('flake8_naming_marker', '', '"N>"')
"" setup markerdata
if !exists('s:markerdata')
let s:markerdata = {}
- let s:markerdata['E'] = { 'name': 'Flake8_Error' }
- let s:markerdata['W'] = { 'name': 'Flake8_Warning' }
- let s:markerdata['F'] = { 'name': 'Flake8_PyFlake' }
- let s:markerdata['C'] = { 'name': 'Flake8_Complexity' }
- let s:markerdata['N'] = { 'name': 'Flake8_Nameing' }
+ let s:markerdata['E'] = {'name': 'Flake8_Error'}
+ let s:markerdata['W'] = {'name': 'Flake8_Warning'}
+ let s:markerdata['F'] = {'name': 'Flake8_PyFlake'}
+ let s:markerdata['C'] = {'name': 'Flake8_Complexity'}
+ let s:markerdata['N'] = {'name': 'Flake8_Nameing'}
endif
let s:markerdata['E'].marker = s:flake8_error_marker
let s:markerdata['W'].marker = s:flake8_warning_marker
let s:markerdata['F'].marker = s:flake8_pyflake_marker
let s:markerdata['C'].marker = s:flake8_complexity_marker
let s:markerdata['N'].marker = s:flake8_naming_marker
+
endfunction " }}}
"" do flake8
" read config
call s:Setup()
- if !executable(s:flake8_cmd)
- echoerr "File " . s:flake8_cmd . " not found. Please install it first."
+ let l:executable = split(s:flake8_cmd)[0]
+
+ if !executable(l:executable)
+ echoerr "File " . l:executable . " not found. Please install it first."
return
endif
let l:old_gfm=&grepformat
let l:old_gp=&grepprg
let l:old_shellpipe=&shellpipe
+ let l:old_t_ti=&t_ti
+ let l:old_t_te=&t_te
" write any changes before continuing
if &readonly == 0
endif
set lazyredraw " delay redrawing
- cclose " close any existing cwindows
- " set shellpipe to > instead of tee (suppressing output)
+ " prevent terminal from blinking
set shellpipe=>
+ set t_ti=
+ set t_te=
" perform the grep itself
let &grepformat="%f:%l:%c: %m\,%f:%l: %m"
- let &grepprg=s:flake8_cmd.s:flake8_builtins.s:flake8_ignore.s:flake8_max_line_length.s:flake8_max_complexity
+ let &grepprg=s:flake8_cmd
silent! grep! "%"
+ " close any existing cwindows,
+ " placed after 'grep' in case quickfix is open on autocmd QuickFixCmdPost
+ cclose
" restore grep settings
let &grepformat=l:old_gfm
let &grepprg=l:old_gp
let &shellpipe=l:old_shellpipe
+ let &t_ti=l:old_t_ti
+ let &t_te=l:old_t_te
+ " store mapping of line number to error string
" process results
+ let s:resultDict = {}
+
let l:results=getqflist()
let l:has_results=results != []
if l:has_results
+ " save line number of each error message
+ for result in l:results
+ let linenum = result.lnum
+ let s:resultDict[linenum] = result.text
+ endfor
+
" markers
if !s:flake8_show_in_gutter == 0 || !s:flake8_show_in_file == 0
call s:PlaceMarkers(l:results)
endif
endfunction " }}}
-"" markers
+function! s:MakeMap(results) " {{{
+ for result in a:results
+ endfor
+endfunction " }}}
+
+"" markers
function! s:PlaceMarkers(results) " {{{
" in gutter?
if !s:flake8_show_in_gutter == 0
endfor
endfunction " }}}
+function! s:ShowErrorMessage() " {{{
+ let l:cursorPos = getpos(".")
+ if !exists('s:resultDict')
+ return
+ endif
+
+ " if there is a message on the current line,
+ " then echo it
+ if has_key(s:resultDict, l:cursorPos[1])
+ let l:errorText = get(s:resultDict, l:cursorPos[1])
+ echo strpart(l:errorText, 0, &columns-1)
+ let b:showing_message = 1
+ endif
+
+ " if a message is already being shown,
+ " then clear it
+ if !b:showing_message == 0
+ echo
+ let b:showing_message = 0
+ endif
+
+endfunction " }}}
+
"" }}}
let &cpo = s:save_cpo