]> 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:

projects / etc / vim.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Allow g:flake8_cmd with parameters
[etc/vim.git] / autoload / flake8.vim
diff --git a/autoload/flake8.vim b/autoload/flake8.vim
index 6aee19c27dc496b4a9f533fee9782a0ff098b0fd..81aedfd3bbc52d882db506ee26ea936465fb9bd3 100644 (file)
--- a/autoload/flake8.vim
+++ b/autoload/flake8.vim
@@ -12,101 +12,115 @@ set cpo&vim
 
 function! flake8#Flake8()
     call s:Flake8()
 
 function! flake8#Flake8()
     call s:Flake8()
+    call s:Warnings()
 endfunction
 
 function! flake8#Flake8UnplaceMarkers()
     call s:UnplaceMarkers()
 endfunction
 
 function! flake8#Flake8UnplaceMarkers()
     call s:UnplaceMarkers()
+    call s:Warnings()
 endfunction
 
 "" }}}
 
 "" ** internal ** {{{
 
 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)  " {{{
     if !exists('g:'.a:name)
 "" config
 
 function! s:DeclareOption(name, globalPrefix, default)  " {{{
     if !exists('g:'.a:name)
-        execute 'let s:'.a:name.'='.a:default
+        if a:default != ''
+            execute 'let s:'.a:name.'='.a:default
+        else
+            execute 'let s:'.a:name.'=""'
+        endif
     else
     else
-        execute 'let s:'.a:name.'="'.a:globalPrefix.'".g:'.a:name
+        execute 'let l:global="g:".a:name'
+        if l:global != ''
+            execute 'let s:'.a:name.'="'.a:globalPrefix.'".g:'.a:name
+        else
+            execute 'let s:'.a:name.'=""'
+        endif
     endif
 endfunction  " }}}
 
     endif
 endfunction  " }}}
 
-function! s:SetupConfig()  " {{{
+function! s:Setup()  " {{{
     "" read options
 
     " flake8 command
     call s:DeclareOption('flake8_cmd', '', '"flake8"')
     "" read options
 
     " 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"')
     " 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)
     " 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
     " 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_complexity_marker', '', '"C>"')
-    call s:DeclareOption('flake8_naming_marker',     '', '"N>"')
+    call s:DeclareOption('flake8_naming_marker', '', '"N>"')
 
     "" setup markerdata
 
 
     "" setup markerdata
 
-    let s:markerdata = {}
-    if s:flake8_error_marker != ''
-    let s:markerdata['E'] = {
-                    \   'color':  'Flake8_Error',
-                    \   'marker': s:flake8_error_marker,
-                    \   'sign':   'Flake8_E',
-                    \ }
-    endif
-    if s:flake8_warning_marker != ''
-        let s:markerdata['W'] = {
-                    \   'color':  'Flake8_Warning',
-                    \   'marker': s:flake8_warning_marker,
-                    \   'sign':   'Flake8_W',
-                    \ }
-    endif
-    if s:flake8_pyflake_marker != ''
-        let s:markerdata['F'] = {
-                    \   'color':  'Flake8_PyFlake',
-                    \   'marker': s:flake8_pyflake_marker,
-                    \   'sign':   'Flake8_F',
-                    \ }
-    endif
-    if s:flake8_complexity_marker != ''
-        let s:markerdata['C'] = {
-                    \   'color':  'Flake8_Complexity',
-                    \   'marker': s:flake8_complexity_marker,
-                    \   'sign':   'Flake8_C',
-                    \ }
-    endif
-    if s:flake8_naming_marker != ''
-        let s:markerdata['N'] = {
-                    \   'color':  'Flake8_Nameing',
-                    \   'marker': s:flake8_naming_marker,
-                    \   'sign':   'Flake8_N',
-                    \ }
+    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'}
     endif
     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
 
 function! s:Flake8()  " {{{
     " read config
 endfunction  " }}}
 
 "" do flake8
 
 function! s:Flake8()  " {{{
     " read config
-    call s:SetupConfig()
+    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
 
         return
     endif
 
+    " clear old
+    call s:UnplaceMarkers()
+    let s:matchids = []
+    let s:signids  = []
+
     " store old grep settings (to restore later)
     let l:old_gfm=&grepformat
     let l:old_gp=&grepprg
     " store old grep settings (to restore later)
     let l:old_gfm=&grepformat
     let l:old_gp=&grepprg
@@ -125,11 +139,9 @@ function! s:Flake8()  " {{{
 
     " perform the grep itself
     let &grepformat="%f:%l:%c: %m\,%f:%l: %m"
 
     " 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! "%"
 
     silent! grep! "%"
 
-    echo s:flake8_cmd.s:flake8_builtins.s:flake8_ignore.s:flake8_max_line_length.s:flake8_max_complexity
-
     " restore grep settings
     let &grepformat=l:old_gfm
     let &grepprg=l:old_gp
     " restore grep settings
     let &grepformat=l:old_gfm
     let &grepprg=l:old_gp
@@ -146,7 +158,7 @@ function! s:Flake8()  " {{{
         " quickfix
         if !s:flake8_show_quickfix == 0
             " open cwindow
         " 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>
             setlocal wrap
             nnoremap <buffer> <silent> c :cclose<CR>
             nnoremap <buffer> <silent> q :cclose<CR>
@@ -171,15 +183,12 @@ function! s:PlaceMarkers(results)  " {{{
     if !s:flake8_show_in_gutter == 0
         " define signs
         for val in values(s:markerdata)
     if !s:flake8_show_in_gutter == 0
         " define signs
         for val in values(s:markerdata)
-            execute "sign define ".val['sign']." text=".val['marker']." texthl=".val['color']
+            if val.marker != ''
+                execute "sign define ".val.name." text=".val.marker." texthl=".val.name
+            endif
         endfor
     endif
 
         endfor
     endif
 
-    " clear old
-    call s:UnplaceMarkers()
-    let s:matchids = []
-    let s:signids  = []
-
     " place
     let l:index0 = 100
     let l:index  = l:index0
     " place
     let l:index0 = 100
     let l:index  = l:index0
@@ -188,21 +197,34 @@ function! s:PlaceMarkers(results)  " {{{
             break
         endif
         let l:type = strpart(result.text, 0, 1)
             break
         endif
         let l:type = strpart(result.text, 0, 1)
-        if has_key(s:markerdata, l:type)
+        if has_key(s:markerdata, l:type) && s:markerdata[l:type].marker != ''
             " file markers
             if !s:flake8_show_in_file == 0
             " file markers
             if !s:flake8_show_in_file == 0
-                let s:matchids += [matchadd(s:markerdata[l:type]['color'],
-                            \ "\\%".result.lnum."l\\%".result.col."c")]
+                if !has_key(s:markerdata[l:type], 'matchstr')
+                    let s:markerdata[l:type].matchstr = '\%('
+                else
+                    let s:markerdata[l:type].matchstr .= '\|'
+                endif
+                let s:markerdata[l:type].matchstr .= '\%'.result.lnum.'l\%'.result.col.'c'
             endif
             " gutter markers
             if !s:flake8_show_in_gutter == 0
             endif
             " gutter markers
             if !s:flake8_show_in_gutter == 0
-                execute ":sign place ".index." name=".s:markerdata[l:type]['sign']
+                execute ":sign place ".index." name=".s:markerdata[l:type].name
                             \ . " line=".result.lnum." file=".expand("%:p")
                 let s:signids += [l:index]
             endif
             let l:index += 1
         endif
     endfor
                             \ . " line=".result.lnum." file=".expand("%:p")
                 let s:signids += [l:index]
             endif
             let l:index += 1
         endif
     endfor
+
+    " in file?
+    if !s:flake8_show_in_file == 0
+        for l:val in values(s:markerdata)
+            if l:val.marker != '' && has_key(l:val, 'matchstr')
+                let l:val.matchid = matchadd(l:val.name, l:val.matchstr.'\)')
+            endif
+        endfor
+    endif
 endfunction  " }}}
 
 function! s:UnplaceMarkers()  " {{{
 endfunction  " }}}
 
 function! s:UnplaceMarkers()  " {{{
@@ -214,12 +236,13 @@ function! s:UnplaceMarkers()  " {{{
         unlet s:signids
     endif
     " file markers
         unlet s:signids
     endif
     " file markers
-    if exists('s:matchids')
-        for i in s:matchids
-            call matchdelete(i)
-        endfor
-        unlet s:matchids
-    endif
+    for l:val in values(s:markerdata)
+        if has_key(l:val, 'matchid')
+            call matchdelete(l:val.matchid)
+            unlet l:val.matchid
+            unlet l:val.matchstr
+        endif
+    endfor
 endfunction  " }}}
 
 "" }}}
 endfunction  " }}}
 
 "" }}}
vim configuration

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.