fix(yaml): make actionlint respect config (#4584)

* fix(yaml): make actionlint respect config
* docs: update actionlint docs
* chore: update author & add description
* test: move actionlint test to test/linter/

ale_linters/yaml/actionlint.vim

@@ -1,11 +1,47 @@
-" Author: bretello <bretello@distruzione.org>
+" Author: Peter Benjamin <petermbenjamin@gmail.com>
+" Description: Linter for GitHub Workflows
 
 call ale#Set('yaml_actionlint_executable', 'actionlint')
 call ale#Set('yaml_actionlint_options', '')
 
+function! ale_linters#yaml#actionlint#GetCommand(buffer) abort
+    let l:options = ale#Var(a:buffer, 'yaml_actionlint_options')
+
+    if l:options !~# '-no-color'
+        let l:options .= ale#Pad('-no-color')
+    endif
+
+    if l:options !~# '-oneline'
+        let l:options .= ale#Pad('-oneline')
+    endif
+
+    return '%e' . ale#Pad(l:options)
+endfunction
+
+function! ale_linters#yaml#actionlint#Handle(buffer, lines) abort
+    " Matches patterns line the following:
+    ".github/workflows/main.yml:19:0: could not parse as YAML: yaml: line 19: mapping values are not allowed in this context [yaml-syntax]
+    let l:pattern = '\v^.*:(\d+):(\d+): (.+) \[(.+)\]$'
+    let l:output = []
+
+    for l:match in ale#util#GetMatches(a:lines, l:pattern)
+        let l:item = {
+        \   'lnum': l:match[1] + 0,
+        \   'col': l:match[2] + 0,
+        \   'text': l:match[3],
+        \   'code': l:match[4],
+        \   'type': 'E',
+        \}
+
+        call add(l:output, l:item)
+    endfor
+
+    return l:output
+endfunction
+
 call ale#linter#Define('yaml', {
 \   'name': 'actionlint',
 \   'executable': {b -> ale#Var(b, 'yaml_actionlint_executable')},
-\   'command': function('ale#handlers#actionlint#GetCommand'),
-\   'callback': 'ale#handlers#actionlint#Handle',
+\   'command': function('ale_linters#yaml#actionlint#GetCommand'),
+\   'callback': 'ale_linters#yaml#actionlint#Handle',
 \})

autoload/ale/handlers/actionlint.vim

@@ -1,36 +0,0 @@
-function! ale#handlers#actionlint#GetCommand(buffer) abort
-    let l:options = ale#Var(a:buffer, 'yaml_actionlint_options')
-
-    " automatically add --no-color option if not defined
-    if l:options !~# '--no-color'
-        let l:options .= ' --no-color'
-    endif
-
-    " automatically add --oneline option if not defined
-    if l:options !~# '--oneline'
-        let l:options .= ' --oneline'
-    endif
-
-    return '%e ' . l:options . ' %t'
-endfunction
-
-function! ale#handlers#actionlint#Handle(buffer, lines) abort
-    " Matches patterns line the following:
-    ".github/workflows/main.yml:19:0: could not parse as YAML: yaml: line 19: mapping values are not allowed in this context [yaml-syntax]
-    let l:pattern = '\v^.*:(\d+):(\d+): (.+) \[(.+)\]$'
-    let l:output = []
-
-    for l:match in ale#util#GetMatches(a:lines, l:pattern)
-        let l:item = {
-        \   'lnum': l:match[1] + 0,
-        \   'col': l:match[2] + 0,
-        \   'text': l:match[3],
-        \   'code': l:match[4],
-        \   'type': 'E',
-        \}
-
-        call add(l:output, l:item)
-    endfor
-
-    return l:output
-endfunction

test/linter/test_yaml_actionlint.vader

@@ -23,21 +23,21 @@ Execute(Problems should be parsed correctly for actionlint):
   \     'code': 'expression',
   \   },
   \ ],
-  \ ale#handlers#actionlint#Handle(bufnr(''), [
+  \ ale_linters#yaml#actionlint#Handle(bufnr(''), [
   \   '.codecov.yaml:2:1: "jobs" section is missing in workflow [syntax-check]',
   \   'workflow_call_event.yaml:56:23: property "unknown_input" is not defined in object type {input7: bool; input0: any; input1: any; input2: string; input3: any; input4: any; input5: number; input6: number} [expression]',
   \ ])
 
-Execute(Command should always have --no-color and --oneline options):
+Execute(Command should always have -no-color and -oneline options):
   let g:ale_yaml_actionlint_options = ''
 
   AssertEqual
-  \   '%e  --no-color --oneline %t',
-  \ ale#handlers#actionlint#GetCommand(bufnr(''))
+  \   '%e  -no-color -oneline',
+  \ ale_linters#yaml#actionlint#GetCommand(bufnr(''))
 
 Execute(Options should be added to command):
   let g:ale_yaml_actionlint_options = '-shellcheck= -pyflakes='
 
   AssertEqual
-  \   '%e -shellcheck= -pyflakes= --no-color --oneline %t',
-  \ ale#handlers#actionlint#GetCommand(bufnr(''))
+  \   '%e -shellcheck= -pyflakes= -no-color -oneline',
+  \ ale_linters#yaml#actionlint#GetCommand(bufnr(''))