Add some VimScript lint tools (#1558)

* Add some VimScript lint tools

https://github.com/syngan/vim-vimlint
https://github.com/Kuniwak/vint

* Remove trailing newlines

* Add augroup to all autocmds

* Fix undefined variables

`l:tmpname` is never defined.

* Explicitly define global variables with g:

* Disable some vint errors

* Change has() syntax to what vimlint wants

* Disable warning for unused variables

Too much effort to fix and vimlint can't deal with closures...

* Install vint in Dockerfile

* Add 2>&1

Author: arp242

.travis.yml

@@ -1,4 +1,6 @@
 language: go
+notifications:
+  email: false
 matrix:
   include:
     - env: SCRIPT=test VIM_VERSION=vim-7.4
@@ -7,5 +9,6 @@ matrix:
     - env: SCRIPT=lint VIM_VERSION=vim-8.0
 install:
   - ./scripts/install-vim $VIM_VERSION
+  - pip install --user vim-vint
 script:
   - ./scripts/$SCRIPT $VIM_VERSION

.vintrc.yaml

@@ -0,0 +1,7 @@
+policies:
+  ProhibitUnnecessaryDoubleQuote:
+    enabled: false
+  ProhibitEqualTildeOperator:
+    enabled: false
+  ProhibitNoAbortFunction:
+    enabled: false

Dockerfile

@@ -1,7 +1,7 @@
 FROM golang:1.9.1
 
 RUN apt-get update -y && \
-  apt-get install -y build-essential curl git libncurses5-dev && \
+  apt-get install -y build-essential curl git libncurses5-dev python3-pip && \
   apt-get clean && \
   rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
 
@@ -14,5 +14,6 @@ WORKDIR /vim-go
 RUN scripts/install-vim vim-7.4
 RUN scripts/install-vim vim-8.0
 RUN scripts/install-vim nvim
+RUN pip3 install vim-vint
 
 ENTRYPOINT ["make"]

autoload/ctrlp/decls.vim

@@ -93,10 +93,6 @@ function! ctrlp#decls#enter() abort
     return
   endif
 
-  if exists("l:tmpname")
-    call delete(l:tmpname)
-  endif
-
   let result = eval(out)
   if type(result) != 4 || !has_key(result, 'decls')
     return

autoload/fzf/decls.vim

@@ -90,10 +90,6 @@ function! s:source(mode,...) abort
     return
   endif
 
-  if exists("l:tmpname")
-    call delete(l:tmpname)
-  endif
-
   let result = eval(out)
   if type(result) != 4 || !has_key(result, 'decls')
     return ret_decls

autoload/go/cmd.vim

@@ -14,7 +14,7 @@ function! go#cmd#Build(bang, ...) abort
   " placeholder with the current folder (indicated with '.'). We also pass -i
   " that tries to install the dependencies, this has the side effect that it
   " caches the build results, so every other build is faster.
-  let args = 
+  let args =
         \ ["build"] +
         \ map(copy(a:000), "expand(v:val)") +
         \ ["-i", ".", "errors"]

autoload/go/coverage.vim

@@ -95,9 +95,9 @@ function! go#coverage#Clear() abort
   if exists("s:toggle") | let s:toggle = 0 | endif
 
   " remove the autocmd we defined
-  if exists("#BufWinLeave#<buffer>")
-    autocmd! BufWinLeave <buffer>
-  endif
+  augroup vim-go-coverage
+    autocmd!
+  augroup end
 endfunction
 
 " Browser creates a new cover profile with 'go test -coverprofile' and opens
@@ -258,7 +258,10 @@ function! go#coverage#overlay(file) abort
   endfor
 
   " clear the matches if we leave the buffer
-  autocmd BufWinLeave <buffer> call go#coverage#Clear()
+  augroup vim-go-coverage
+    autocmd!
+    autocmd BufWinLeave <buffer> call go#coverage#Clear()
+  augroup end
 
   for m in matches
     call matchaddpos(m.group, m.pos)

autoload/go/fmt.vim

@@ -131,7 +131,7 @@ function! go#fmt#update_file(source, target)
 
   " the title information was introduced with 7.4-2200
   " https://github.com/vim/vim/commit/d823fa910cca43fec3c31c030ee908a14c272640
-  if has('patch-7.4-2200')
+  if has('patch-7.4.2200')
     " clean up previous list
     if l:listtype == "quickfix"
       let l:list_title = getqflist({'title': 1})

autoload/go/guru.vim

@@ -529,7 +529,10 @@ function! s:same_ids_highlight(exit_val, output) abort
   if get(g:, "go_auto_sameids", 0)
     " re-apply SameIds at the current cursor position at the time the buffer
     " is redisplayed: e.g. :edit, :GoRename, etc.
-    autocmd BufWinEnter <buffer> nested call go#guru#SameIds()
+    augroup vim-go-sameids
+      autocmd!
+      autocmd BufWinEnter <buffer> nested call go#guru#SameIds()
+    augroup end
   endif
 endfunction
 
@@ -551,9 +554,9 @@ function! go#guru#ClearSameIds() abort
   endif
 
   " remove the autocmds we defined
-  if exists("#BufWinEnter#<buffer>")
-    autocmd! BufWinEnter <buffer>
-  endif
+  augroup vim-go-sameids
+    autocmd!
+  augroup end
 
   return 0
 endfunction

autoload/go/list.vim

@@ -7,9 +7,9 @@ if !exists("g:go_list_type_commands")
 endif
 
 " Window opens the list with the given height up to 10 lines maximum.
-" Otherwise g:go_loclist_height is used. 
+" Otherwise g:go_loclist_height is used.
 "
-" If no or zero height is given it closes the window by default.  
+" If no or zero height is given it closes the window by default.
 " To prevent this, set g:go_list_autoclose = 0
 function! go#list#Window(listtype, ...) abort
   " we don't use lwindow to close the location list as we need also the

autoload/go/tags.vim

@@ -100,7 +100,7 @@ func s:write_out(out) abort
     call go#list#Window(l:listtype, len(result['errors']))
 
     "prevent jumping to quickfix list
-    exe l:winnr . "wincmd w" 
+    exe l:winnr . "wincmd w"
   endif
 endfunc
 

autoload/go/test.vim

@@ -226,7 +226,7 @@ endfunction
 
 " show_errors parses the given list of lines of a 'go test' output and returns
 " a quickfix compatible list of errors. It's intended to be used only for go
-" test output. 
+" test output.
 function! s:show_errors(args, exit_val, messages) abort
   let l:listtype = go#list#Type("GoTest")
 

autoload/gotest.vim

@@ -67,7 +67,9 @@ fun! gotest#assert_buffer(skipHeader, want) abort
     for l:lnum in range(0, len(l:buffer) - 1)
       " Bit rudimentary, but works reasonably well.
       if match(l:buffer[l:lnum], '^\v(func|var|const|import \(|\))') > -1
-        let l:buffer = l:buffer[l:lnum:]
+        " vint bug: https://github.com/Kuniwak/vint/issues/179
+        " vint: -ProhibitUsingUndeclaredVariable
+        let l:buffer = l:buffer[l:lnum:len(l:buffer)]
         break
       endif
     endfor

compiler/go.vim

@@ -4,10 +4,10 @@
 "
 " compiler/go.vim: Vim compiler file for Go.
 
-if exists("current_compiler")
+if exists("g:current_compiler")
   finish
 endif
-let current_compiler = "go"
+let g:current_compiler = "go"
 
 if exists(":CompilerSet") != 2
   command -nargs=* CompilerSet setlocal <args>

ftdetect/gofiletype.vim

@@ -18,14 +18,17 @@ function! s:gofiletype_post()
   let &g:fileencodings = s:current_fileencodings
 endfunction
 
-au BufNewFile *.go setfiletype go | setlocal fileencoding=utf-8 fileformat=unix
-au BufRead *.go call s:gofiletype_pre("go")
-au BufReadPost *.go call s:gofiletype_post()
+augroup vim-go-filetype
+  autocmd!
+  au BufNewFile *.go setfiletype go | setlocal fileencoding=utf-8 fileformat=unix
+  au BufRead *.go call s:gofiletype_pre("go")
+  au BufReadPost *.go call s:gofiletype_post()
 
-au BufNewFile *.s setfiletype asm | setlocal fileencoding=utf-8 fileformat=unix
-au BufRead *.s call s:gofiletype_pre("asm")
-au BufReadPost *.s call s:gofiletype_post()
+  au BufNewFile *.s setfiletype asm | setlocal fileencoding=utf-8 fileformat=unix
+  au BufRead *.s call s:gofiletype_pre("asm")
+  au BufReadPost *.s call s:gofiletype_post()
 
-au BufRead,BufNewFile *.tmpl set filetype=gohtmltmpl
+  au BufRead,BufNewFile *.tmpl set filetype=gohtmltmpl
+augroup end
 
 " vim: sw=2 ts=2 et

scripts/install-vim

@@ -90,13 +90,19 @@ else
 fi
 
 # Make sure all Go tools and other dependencies are installed.
+echo "Installing Go binaries"
 export GOPATH=$installdir
 export PATH=${GOPATH}/bin:$PATH
 "$vimgodir/scripts/run-vim" $vim +':silent :GoUpdateBinaries' +':qa'
 
-[ -d "$installdir/share/vim/vimgo/pack/vim-go/start/vim-vimhelplint" ] || \
-  git clone --depth 1 --quiet https://github.com/machakann/vim-vimhelplint \
-    "$installdir/share/vim/vimgo/pack/vim-go/start/vim-vimhelplint"
+echo "Installing lint tools"
+(
+  mkdir -p "$installdir/share/vim/vimgo/pack/vim-go/start/"
+  cd "$installdir/share/vim/vimgo/pack/vim-go/start/"
+  [ -d "vim-vimhelplint" ] || git clone --depth 1 --quiet https://github.com/machakann/vim-vimhelplint
+  [ -d "vim-vimlparser" ]  || git clone --depth 1 --quiet https://github.com/ynkdir/vim-vimlparser
+  [ -d "vim-vimlint" ]     || git clone --depth 1 --quiet https://github.com/syngan/vim-vimlint
+)
 
 # Don't really need source after successful install.
 rm -rf "$srcdir"

scripts/lint

@@ -25,6 +25,45 @@ if [ ! -f "$vimdir/bin/vim" ]; then
 	exit 1
 fi
 
+### Run vint
+############
+failed=0
+printf "Running vint ... "
+if [ -x "$(command -v vint)" ]; then
+  lint=$(vint "$vimgodir" 2>&1 ||:)
+  if [ -n "$lint" ]; then
+    echo "FAILED"
+    echo "$lint"
+    echo
+    failed=6
+  else
+    echo "PASSED"
+  fi
+else
+  echo "SKIPPED"
+  echo "'vint' binary not found; use 'pip install vim-vint' to install it."
+fi
+
+### Run vim-vimlint
+###################
+printf "Running vim-vimlint ... "
+lint=$(sh "$vimdir/share/vim/vimgo/pack/vim-go/start/vim-vimlint/bin/vimlint.sh" \
+  -p "$vimdir/share/vim/vimgo/pack/vim-go/start/vim-vimlparser" \
+  -l "$vimdir/share/vim/vimgo/pack/vim-go/start/vim-vimlint" \
+  -u \
+  -c func_abort=1 \
+  -e EVL110=1 -e EVL103=1 -e EVL104=1 -e EVL102=1 \
+  "$vimgodir" \
+  2>&1 ||:)
+if [ -n "$lint" ]; then
+  echo "FAILED"
+  echo "$lint"
+  echo
+  failed=6
+else
+  echo "PASSED"
+fi
+
 ### Run vimhelplint.
 ####################
 printf "Running vimhelplint ... "
@@ -37,12 +76,13 @@ lint=$($vimdir/bin/vim -esNR \
   +"e $vimgodir/doc/vim-go.txt" \
   +'verbose VimhelpLintEcho' \
   +q \
-  2>&1)
+  2>&1 ||:)
 if [ "$lint" ]; then
   echo "FAILED"
   echo "$lint"
-  exit 6
+  failed=6
 else
   echo "PASSED"
-  exit 0
 fi
+
+exit "$failed"

scripts/runtest.vim

@@ -1,5 +1,7 @@
 " Make sure some options are set to sane defaults and output all messages in
 " English.
+
+" vint: -ProhibitSetNoCompatible
 set nocompatible nomore shellslash encoding=utf-8 shortmess+=WIF
 lang mess C
 

syntax/gohtmltmpl.vim

@@ -2,8 +2,8 @@ if exists("b:current_syntax")
   finish
 endif
 
-if !exists("main_syntax")
-  let main_syntax = 'html'
+if !exists("g:main_syntax")
+  let g:main_syntax = 'html'
 endif
 
 runtime! syntax/gotexttmpl.vim