Merge pull request #2835 from bhcleek/lint/golangci-lint-is-inconsistent-and-undocumented

lint: try to parse golangci-lint errors better

Author: bhcleek

autoload/go/lint.vim

@@ -442,14 +442,40 @@ endfunction
 
 function! s:errorformat(metalinter) abort
   if a:metalinter == 'golangci-lint'
-    " Golangci-lint can output the following:
-    "   <file>:<line>:<column>: <message> (<linter>)
-    " This can be defined by the following errorformat:
-    return 'level=%tarning\ msg="%m:\ [%f:%l:%c:\ %.%#]",level=%tarning\ msg="%m",level=%trror\ msg="%m:\ [%f:%l:%c:\ %.%#]",level=%trror\ msg="%m",%f:%l:%c:\ %m,%f:%l\ %m'
+    let l:efm = ''
+
+    " Golangci-lint can several formats, all of which seem to be undocumented.
+    " Based on trial and error, these error format strings seem to catch all
+    " the relevant combinations.
+
+    " When the actual locations and error message is wrapped in parentheses
+    " within brackets (there is usually duplicated location information in
+    " this form). This usually happens when the linter can't do its job
+    " because of compiler or AST problems.
+    let l:efm .= 'level=%tarning\ msg="%.%#(%f:%l:%c:\ %m)\ %.%#]"'
+    let l:efm .= ',level=%trror\ msg="%.%#(%f:%l:%c:\ %m)\ %.%#]"'
+
+    " When the actual locations and error message are not wrapped in
+    " in bracked without the inner parenthetical. This usually happens when
+    " the linter can't do its job because of compiler or AST problems.
+    let l:efm .= ',level=%tarning\ msg="%.%#:\ [%f:%l:%c:\ %m]"'
+    let l:efm .= ',level=%trror\ msg="%.%#:\ [%f:%l:%c:\ %m]"'
+
+    " When the file location is not provided. The usually happens when the
+    " linter can't do its job because of some other problem.
+    let l:efm .= ',level=%tarning\ msg="%m"'
+    let l:efm .= ',level=%trror\ msg="%m"'
+
+    " when the linter was able to compile and/or create the AST, and the
+    " linter found some problems.
+    let l:efm .= ',%f:%l:%c:\ %m'
+    let l:efm .= ',%f:%l\ %m'
   elseif a:metalinter == 'gopls'
-    return '%f:%l:%c:%t:\ %m,%f:%l:%c::\ %m'
+    let l:efm = '%f:%l:%c:%t:\ %m'
+    let l:efm .= ',%f:%l:%c::\ %m'
   endif
 
+  return l:efm
 endfunction
 
 function! s:preserveerrors(autosave, listtype) abort

autoload/go/lint_test.vim

@@ -53,10 +53,9 @@ func! s:gometa_problems(metalinter) abort
   try
     let g:go_metalinter_command = a:metalinter
     let expected = [
-          \ {'lnum': 3, 'bufnr': bufnr('%'), 'col': 8, 'pattern': '', 'valid': 1, 'vcol': 0, 'nr': -1, 'type': 'w', 'module': '', 'text': '[runner] Can''t run linter golint: golint: analysis skipped: errors in package'},
-          \ {'lnum': 3, 'bufnr': bufnr('%'), 'col': 8, 'pattern': '', 'valid': 1, 'vcol': 0, 'nr': -1, 'type': 'e', 'module': '', 'text': 'Running error: golint: analysis skipped: errors in package'}
+          \ {'lnum': 3, 'bufnr': bufnr('%'), 'col': 8, 'pattern': '', 'valid': 1, 'vcol': 0, 'nr': -1, 'type': 'w', 'module': '', 'text': 'import \"/quux\": cannot import absolute path'},
+          \ {'lnum': 3, 'bufnr': bufnr('%'), 'col': 8, 'pattern': '', 'valid': 1, 'vcol': 0, 'nr': -1, 'type': 'e', 'module': '', 'text': 'import \"/quux\": cannot import absolute path'},
         \ ]
-
     " clear the quickfix lists
     call setqflist([], 'r')
 
@@ -141,8 +140,8 @@ func! s:gometaautosave_problems(metalinter) abort
   try
     let g:go_metalinter_command = a:metalinter
     let expected = [
-          \ {'lnum': 3, 'bufnr': bufnr('%')+1, 'col': 8, 'pattern': '', 'valid': 1, 'vcol': 0, 'nr': -1, 'type': 'w', 'module': '', 'text': '[runner] Can''t run linter golint: golint: analysis skipped: errors in package'},
-          \ {'lnum': 3, 'bufnr': bufnr('%')+1, 'col': 8, 'pattern': '', 'valid': 1, 'vcol': 0, 'nr': -1, 'type': 'e', 'module': '', 'text': 'Running error: golint: analysis skipped: errors in package'}
+          \ {'lnum': 3, 'bufnr': bufnr('%')+1, 'col': 8, 'pattern': '', 'valid': 1, 'vcol': 0, 'nr': -1, 'type': 'w', 'module': '', 'text': 'import \"/quux\": cannot import absolute path'},
+          \ {'lnum': 3, 'bufnr': bufnr('%')+1, 'col': 8, 'pattern': '', 'valid': 1, 'vcol': 0, 'nr': -1, 'type': 'e', 'module': '', 'text': 'import \"/quux\": cannot import absolute path'},
         \ ]
 
     " clear the location lists