]> git.madduck.net Git - etc/vim.git/blobdiff - autoload/flake8.vim

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:

Merge pull request #72 from antoinemadec/no_blink
[etc/vim.git] / autoload / flake8.vim
index de9633e802d732064c69d2ab2903dc12a7e47a0d..cf592cf7247764fcbe504101123ec695b048b53d 100644 (file)
@@ -12,16 +12,41 @@ set cpo&vim
 
 function! flake8#Flake8()
     call s:Flake8()
+    call s:Warnings()
 endfunction
 
 function! flake8#Flake8UnplaceMarkers()
     call s:UnplaceMarkers()
+    call s:Warnings()
 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)  " {{{
@@ -46,34 +71,30 @@ function! s:Setup()  " {{{
 
     " 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_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
@@ -88,8 +109,10 @@ function! s: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
 
@@ -102,6 +125,8 @@ function! s:Flake8()  " {{{
     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
@@ -109,20 +134,26 @@ function! s:Flake8()  " {{{
     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
 
     " process results
     let l:results=getqflist()
@@ -135,7 +166,7 @@ function! s:Flake8()  " {{{
         " quickfix
         if !s:flake8_show_quickfix == 0
             " open cwindow
-            execute s:flake8_quickfix_location." copen"
+            execute s:flake8_quickfix_location." copen".s:flake8_quickfix_height
             setlocal wrap
             nnoremap <buffer> <silent> c :cclose<CR>
             nnoremap <buffer> <silent> q :cclose<CR>