#810 - Handle output which is not JSON in many linters

ale_linters/crystal/crystal.vim

@@ -4,31 +4,21 @@
 function! ale_linters#crystal#crystal#Handle(buffer, lines) abort
     let l:output = []
 
-    let l:lines = join(a:lines, '')
+    for l:error in ale#util#FuzzyJSONDecode(a:lines, [])
-
+        call add(l:output, {
-    if !empty(l:lines)
+        \   'lnum': l:error.line + 0,
-      let l:errors = json_decode(l:lines)
+        \   'col': l:error.column + 0,
-
+        \   'text': l:error.message,
-      for l:error in l:errors
+        \})
-          call add(l:output, {
+    endfor
-          \   'bufnr': a:buffer,
-          \   'lnum': l:error.line + 0,
-          \   'col': l:error.column + 0,
-          \   'text': l:error.message,
-          \   'type': 'E',
-          \})
-      endfor
-    endif
 
     return l:output
 endfunction
 
 function! ale_linters#crystal#crystal#GetCommand(buffer) abort
-    let l:crystal_cmd = 'crystal build -f json --no-codegen --no-color -o '
+    return 'crystal build -f json --no-codegen --no-color -o '
-    let l:crystal_cmd .= ale#Escape(g:ale#util#nul_file)
+    \   . ale#Escape(g:ale#util#nul_file)
-    let l:crystal_cmd .= ' %s'
+    \   . ' %s'
-
-    return l:crystal_cmd
 endfunction
 
 call ale#linter#Define('crystal', {

ale_linters/handlebars/embertemplatelint.vim

@@ -16,16 +16,10 @@ function! ale_linters#handlebars#embertemplatelint#GetCommand(buffer) abort
 endfunction
 
 function! ale_linters#handlebars#embertemplatelint#Handle(buffer, lines) abort
-    if len(a:lines) == 0
-      return []
-    endif
-
     let l:output = []
+    let l:json = ale#util#FuzzyJSONDecode(a:lines, {})
 
-    let l:input_json = json_decode(join(a:lines, ''))
+    for l:error in get(values(l:json), 0, [])
-    let l:file_errors = values(l:input_json)[0]
-
-    for l:error in l:file_errors
         if has_key(l:error, 'fatal')
             call add(l:output, {
             \   'bufnr': a:buffer,

ale_linters/haskell/hlint.vim

@@ -2,15 +2,9 @@
 " Description: hlint for Haskell files
 
 function! ale_linters#haskell#hlint#Handle(buffer, lines) abort
-    if empty(a:lines)
-        return []
-    endif
-
-    let l:errors = json_decode(join(a:lines, ''))
-
     let l:output = []
 
-    for l:error in l:errors
+    for l:error in ale#util#FuzzyJSONDecode(a:lines, [])
         if l:error.severity ==# 'Error'
             let l:type = 'E'
         elseif l:error.severity ==# 'Suggestion'

ale_linters/ruby/brakeman.vim

@@ -5,20 +5,10 @@ let g:ale_ruby_brakeman_options =
 \   get(g:, 'ale_ruby_brakeman_options', '')
 
 function! ale_linters#ruby#brakeman#Handle(buffer, lines) abort
-    if len(a:lines) == 0
-        return []
-    endif
-
-    try
-        let l:result = json_decode(join(a:lines, ''))
-    catch /E474/
-        " Ignore invalid JSON
-        return []
-    endtry
-
     let l:output = []
+    let l:json = ale#util#FuzzyJSONDecode(a:lines, {})
 
-    for l:warning in l:result.warnings
+    for l:warning in get(l:json, 'warnings', [])
         " Brakeman always outputs paths relative to the Rails app root
         let l:rails_root = ale#ruby#FindRailsRoot(a:buffer)
         let l:warning_file = l:rails_root . '/' . l:warning.file

ale_linters/ruby/rails_best_practices.vim

@@ -5,17 +5,11 @@ let g:ale_ruby_rails_best_practices_options =
 \   get(g:, 'ale_ruby_rails_best_practices_options', '')
 
 function! ale_linters#ruby#rails_best_practices#Handle(buffer, lines) abort
-    if len(a:lines) == 0
-        return []
-    endif
-
-    let l:result = json_decode(join(a:lines, ''))
-
     let l:output = []
 
-    for l:warning in l:result
+    for l:warning in ale#util#FuzzyJSONDecode(a:lines, [])
         if !ale#path#IsBufferPath(a:buffer, l:warning.filename)
-          continue
+            continue
         endif
 
         call add(l:output, {

ale_linters/ruby/reek.vim

@@ -1,22 +1,13 @@
 " Author: Eddie Lebow https://github.com/elebow
 " Description: Reek, a code smell detector for Ruby files
 
-let g:ale_ruby_reek_show_context =
+call ale#Set('ruby_reek_show_context', 0)
-\   get(g:, 'ale_ruby_reek_show_context', 0)
+call ale#Set('ruby_reek_show_wiki_link', 0)
-
-let g:ale_ruby_reek_show_wiki_link =
-\   get(g:, 'ale_ruby_reek_show_wiki_link', 0)
 
 function! ale_linters#ruby#reek#Handle(buffer, lines) abort
-    if len(a:lines) == 0
-        return []
-    endif
-
-    let l:errors = json_decode(a:lines[0])
-
     let l:output = []
 
-    for l:error in l:errors
+    for l:error in ale#util#FuzzyJSONDecode(a:lines, [])
         for l:location in l:error.lines
             call add(l:output, {
             \    'lnum': l:location,

ale_linters/typescript/tslint.vim

@@ -14,11 +14,7 @@ endfunction
 function! ale_linters#typescript#tslint#Handle(buffer, lines) abort
     let l:output = []
 
-    if empty(a:lines)
+    for l:error in ale#util#FuzzyJSONDecode(a:lines, [])
-        return []
-    endif
-
-    for l:error in json_decode(join(a:lines, ''))
         if ale#path#IsBufferPath(a:buffer, l:error.name)
             call add(l:output, {
             \   'type': (get(l:error, 'ruleSeverity', '') ==# 'WARNING' ? 'W' : 'E'),

test/handler/test_crystal_handler.vader

@@ -4,9 +4,7 @@ Execute(The crystal handler should parse lines correctly and add the column if i
   \ [
   \   {
   \     'lnum': 2,
-  \     'bufnr': 255,
   \     'col': 1,
-  \     'type': 'E',
   \     'text': 'unexpected token: EOF'
   \   }
   \ ],

test/handler/test_embertemplatelint_handler.vader

@@ -75,9 +75,11 @@ Execute(The ember-template-lint handler should handle template parsing error cor
 
 Execute(The ember-template-lint handler should handle no lint errors/warnings):
   AssertEqual
-  \ [
+  \ [],
-  \ ],
   \ ale_linters#handlebars#embertemplatelint#Handle(347, [])
+  AssertEqual
+  \ [],
+  \ ale_linters#handlebars#embertemplatelint#Handle(347, ['{}'])
 
 After:
   call ale#linter#Reset()

test/handler/test_rails_best_practices_handler.vader

@@ -1,20 +1,15 @@
 Before:
-    " Switch to the test rails directory.
+  call ale#test#SetDirectory('/testplugin/test/handler')
-    let b:path = getcwd()
+  cd ..
-    silent! cd /testplugin/test/handler
-    cd ../ruby_fixtures/valid_rails_app/app/models
 
-    runtime ale_linters/ruby/rails_best_practices.vim
+  runtime ale_linters/ruby/rails_best_practices.vim
 
 After:
-    " Switch back to whatever directory it was that we started on.
+  call ale#test#RestoreDirectory()
-    silent! 'cd ' . fnameescape(b:path)
+  call ale#linter#Reset()
-    unlet! b:path
-
-    call ale#linter#Reset()
 
 Execute(The rails_best_practices handler should parse JSON correctly):
-  silent file! thing.rb
+  call ale#test#SetFilename('ruby_fixtures/valid_rails_app/app/models/thing.rb')
 
   AssertEqual
   \  [
@@ -34,11 +29,11 @@ Execute(The rails_best_practices handler should parse JSON correctly):
   \    '{',
   \      '"message": "use local variable",',
   \      '"line_number": "5",',
-  \      '"filename": "/testplugin/test/ruby_fixtures/valid_rails_app/app/models/thing.rb"',
+  \      '"filename": "' . g:dir . '/ruby_fixtures/valid_rails_app/app/models/thing.rb"',
   \    '},{',
   \      '"message": "other advice",',
   \      '"line_number": "10",',
-  \      '"filename": "/testplugin/test/ruby_fixtures/valid_rails_app/app/models/thing.rb"',
+  \      '"filename": "' . g:dir . '/ruby_fixtures/valid_rails_app/app/models/thing.rb"',
   \    '}',
   \  ']'
   \  ])
@@ -48,3 +43,10 @@ Execute(The rails_best_practices handler should parse JSON correctly when there
   \ [],
   \ ale_linters#ruby#rails_best_practices#Handle(347, [
   \ ])
+
+Execute(The rails_best_practices handler should handle garbage output):
+  AssertEqual
+  \ [],
+  \ ale_linters#ruby#rails_best_practices#Handle(347, [
+  \   'No such command in 2.4.1 of ruby',
+  \ ])

test/handler/test_reek_handler.vader

@@ -2,68 +2,75 @@ Before:
   runtime ale_linters/ruby/reek.vim
 
 After:
-    call ale#linter#Reset()
+  call ale#linter#Reset()
 
 Execute(The reek handler should parse JSON correctly, with only context enabled):
-    let g:ale_ruby_reek_show_context = 1
+  let g:ale_ruby_reek_show_context = 1
-    let g:ale_ruby_reek_show_wiki_link = 0
+  let g:ale_ruby_reek_show_wiki_link = 0
 
-    AssertEqual
+  AssertEqual
-    \ [
+  \ [
-    \     {
+  \     {
-    \         'lnum': 12,
+  \         'lnum': 12,
-    \         'text': 'Rule1: Context#method violates rule number one',
+  \         'text': 'Rule1: Context#method violates rule number one',
-    \         'type': 'W',
+  \         'type': 'W',
-    \     },
+  \     },
-    \     {
+  \     {
-    \         'lnum': 34,
+  \         'lnum': 34,
-    \         'text': 'Rule2: Context#method violates rule number two',
+  \         'text': 'Rule2: Context#method violates rule number two',
-    \         'type': 'W',
+  \         'type': 'W',
-    \     },
+  \     },
-    \     {
+  \     {
-    \         'lnum': 56,
+  \         'lnum': 56,
-    \         'text': 'Rule2: Context#method violates rule number two',
+  \         'text': 'Rule2: Context#method violates rule number two',
-    \         'type': 'W',
+  \         'type': 'W',
-    \     },
+  \     },
-    \ ],
+  \ ],
-    \ ale_linters#ruby#reek#Handle(347, [
+  \ ale_linters#ruby#reek#Handle(347, [
-    \     '[{"context":"Context#method","lines":[12],"message":"violates rule number one","smell_type":"Rule1","source":"/home/user/file.rb","parameter":"bad parameter","wiki_link":"https://example.com/Rule1.md"},{"context":"Context#method","lines":[34, 56],"message":"violates rule number two","smell_type":"Rule2","source":"/home/user/file.rb","name":"bad code","count":2,"wiki_link":"https://example.com/Rule1.md"}]'
+  \     '[{"context":"Context#method","lines":[12],"message":"violates rule number one","smell_type":"Rule1","source":"/home/user/file.rb","parameter":"bad parameter","wiki_link":"https://example.com/Rule1.md"},{"context":"Context#method","lines":[34, 56],"message":"violates rule number two","smell_type":"Rule2","source":"/home/user/file.rb","name":"bad code","count":2,"wiki_link":"https://example.com/Rule1.md"}]'
-    \ ])
+  \ ])
 
 Execute(The reek handler should parse JSON correctly, with no context or wiki links):
-    let g:ale_ruby_reek_show_context = 0
+  let g:ale_ruby_reek_show_context = 0
-    let g:ale_ruby_reek_show_wiki_link = 0
+  let g:ale_ruby_reek_show_wiki_link = 0
 
-    AssertEqual
+  AssertEqual
-    \ [
+  \ [
-    \     {
+  \     {
-    \         'lnum': 12,
+  \         'lnum': 12,
-    \         'text': 'Rule1: violates rule number one',
+  \         'text': 'Rule1: violates rule number one',
-    \         'type': 'W',
+  \         'type': 'W',
-    \     },
+  \     },
-    \ ],
+  \ ],
-    \ ale_linters#ruby#reek#Handle(347, [
+  \ ale_linters#ruby#reek#Handle(347, [
-    \     '[{"context":"Context#method","lines":[12],"message":"violates rule number one","smell_type":"Rule1","source":"/home/user/file.rb","parameter":"bad parameter","wiki_link":"https://example.com/Rule1.md"}]'
+  \     '[{"context":"Context#method","lines":[12],"message":"violates rule number one","smell_type":"Rule1","source":"/home/user/file.rb","parameter":"bad parameter","wiki_link":"https://example.com/Rule1.md"}]'
-    \ ])
+  \ ])
 
 Execute(The reek handler should parse JSON correctly, with both context and wiki links):
-    let g:ale_ruby_reek_show_context = 1
+  let g:ale_ruby_reek_show_context = 1
-    let g:ale_ruby_reek_show_wiki_link = 1
+  let g:ale_ruby_reek_show_wiki_link = 1
 
-    AssertEqual
+  AssertEqual
-    \ [
+  \ [
-    \     {
+  \     {
-    \         'lnum': 12,
+  \         'lnum': 12,
-    \         'text': 'Rule1: Context#method violates rule number one [https://example.com/Rule1.md]',
+  \         'text': 'Rule1: Context#method violates rule number one [https://example.com/Rule1.md]',
-    \         'type': 'W',
+  \         'type': 'W',
-    \     },
+  \     },
-    \ ],
+  \ ],
-    \ ale_linters#ruby#reek#Handle(347, [
+  \ ale_linters#ruby#reek#Handle(347, [
-    \     '[{"context":"Context#method","lines":[12],"message":"violates rule number one","smell_type":"Rule1","source":"/home/user/file.rb","parameter":"bad parameter","wiki_link":"https://example.com/Rule1.md"}]'
+  \     '[{"context":"Context#method","lines":[12],"message":"violates rule number one","smell_type":"Rule1","source":"/home/user/file.rb","parameter":"bad parameter","wiki_link":"https://example.com/Rule1.md"}]'
-    \ ])
+  \ ])
 
 Execute(The reek handler should parse JSON correctly when there is no output from reek):
-    AssertEqual
+  AssertEqual
-    \ [],
+  \ [],
-    \ ale_linters#ruby#reek#Handle(347, [
+  \ ale_linters#ruby#reek#Handle(347, [
-    \ ])
+  \ ])
+
+Execute(The reek handler should handle garbage output):
+  AssertEqual
+  \ [],
+  \ ale_linters#ruby#reek#Handle(347, [
+  \   'No such command in 2.4.1 of ruby',
+  \ ])