Add explicit instructions about configuring flake8

[etc/vim.git] / autoload / flake8.vim

diff --git a/autoload/flake8.vim b/autoload/flake8.vim
index 5c54ad1a1fd54b2008e3af9a5724102530963379..06a1b6b4873a78bd3a70540376593359a53730c7 100644 (file)
--- a/autoload/flake8.vim
+++ b/autoload/flake8.vim
@@ -12,16 +12,41 @@ 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)  " {{{
 "" config
 
 function! s:DeclareOption(name, globalPrefix, default)  " {{{


@@ -46,35 +71,30 @@ function! s:Setup()  " {{{
 
     " flake8 command
     call s:DeclareOption('flake8_cmd', '', '"flake8"')
 
     " 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_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)
     " 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
 
     if !exists('s:markerdata')
         let s:markerdata = {}
 
     "" 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
     endif
     let s:markerdata['E'].marker = s:flake8_error_marker
     let s:markerdata['W'].marker = s:flake8_warning_marker


@@ -117,7 +137,7 @@ 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! "%"
 
     " restore grep settings
     silent! grep! "%"
 
     " restore grep settings