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

Add 1.6 release log.
[etc/vim.git] / autoload / flake8.vim
index 67d696584dd30fc8760d1ffae3036a896be2f42b..a958ec5d73acf9fd7c4a3d324898a0ad81e432e3 100644 (file)
@@ -8,40 +8,69 @@
 let s:save_cpo = &cpo
 set cpo&vim
 
-"" external {{{
+"" ** external ** {{{
 
 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 depreciated 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)
-        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
-        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  " }}}
 
-function! s:SetupConfig()  " {{{
+function! s:Setup()  " {{{
     "" 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"')
     call s:DeclareOption('flake8_show_quickfix',     '', 1)
@@ -58,55 +87,37 @@ function! s:SetupConfig()  " {{{
 
     "" 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
+    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
-    call s:SetupConfig()
+    call s:Setup()
 
     if !executable(s:flake8_cmd)
         echoerr "File " . s:flake8_cmd . " not found. Please install it first."
         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
@@ -125,11 +136,9 @@ function! s:Flake8()  " {{{
 
     " 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! "%"
 
-    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
@@ -171,34 +180,48 @@ function! s:PlaceMarkers(results)  " {{{
     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
 
-    " clear old
-    call s:UnplaceMarkers()
-    let s:matchids = []
-    let s:signids  = []
-
     " place
-    let index = 100
+    let l:index0 = 100
+    let l:index  = l:index0
     for result in a:results
-        let type = strpart(result.text, 0, 1)
-        if has_key(s:markerdata, type)
+        if l:index >= (s:flake8_max_markers+l:index0)
+            break
+        endif
+        let l:type = strpart(result.text, 0, 1)
+        if has_key(s:markerdata, l:type) && s:markerdata[l:type].marker != ''
             " file markers
             if !s:flake8_show_in_file == 0
-                let s:matchids += [matchadd(s:markerdata[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
-                execute ":sign place ".index." name=".s:markerdata[type]['sign']
+                execute ":sign place ".index." name=".s:markerdata[l:type].name
                             \ . " line=".result.lnum." file=".expand("%:p")
-                let s:signids += [index]
-                let index += 1
+                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()  " {{{
@@ -210,12 +233,13 @@ function! s:UnplaceMarkers()  " {{{
         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  " }}}
 
 "" }}}