Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Actionlint: correctly parse error line when using shellcheck sublinter #4689

Merged
merged 1 commit into from
Jan 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 15 additions & 3 deletions ale_linters/yaml/actionlint.vim
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,27 @@ 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:pattern = '\v^.{-}:(\d+):(\d+): (.+) \[(.+)\]$'
hsanson marked this conversation as resolved.
Show resolved Hide resolved
let l:output = []


for l:match in ale#util#GetMatches(a:lines, l:pattern)
let l:code = l:match[4]
let l:text = l:match[3]

" Handle sub-linter errors like the following:
hsanson marked this conversation as resolved.
Show resolved Hide resolved
"validate.yml:19:9: shellcheck reported issue in this script: SC2086:info:1:15: Double quote to prevent globbing and word splitting [shellcheck]
if l:code is# 'shellcheck'
let l:shellcheck_match = matchlist(l:text, '\v^.+: (SC\d{4}):.+:\d+:\d+: (.+)$')
let l:text = l:shellcheck_match[2]
let l:code = 'shellcheck ' . l:shellcheck_match[1]
endif

let l:item = {
\ 'lnum': l:match[1] + 0,
\ 'col': l:match[2] + 0,
\ 'text': l:match[3],
\ 'code': l:match[4],
\ 'text': l:text,
\ 'code': l:code,
\ 'type': 'E',
\}

Expand Down
20 changes: 17 additions & 3 deletions test/linter/test_yaml_actionlint.vader
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
Before:
runtime! ale/handlers/actionlint.vim
call ale#assert#SetUpLinterTest('yaml', 'actionlint')

After:
unlet! g:ale_yaml_actionlint_options
call ale#linter#Reset()
call ale#assert#TearDownLinterTest()
hsanson marked this conversation as resolved.
Show resolved Hide resolved

Execute(Problems should be parsed correctly for actionlint):
AssertEqual
Expand All @@ -28,6 +27,21 @@ Execute(Problems should be parsed correctly for actionlint):
\ '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(Shellcheck issues should be reported at the line they appear):
hsanson marked this conversation as resolved.
Show resolved Hide resolved
AssertEqual
\ [
\ {
\ 'lnum': 19,
\ 'col': 9,
\ 'type': 'E',
\ 'text': 'Double quote to prevent globbing and word splitting',
\ 'code': 'shellcheck SC2086',
\ },
\ ],
\ ale_linters#yaml#actionlint#Handle(bufnr(''), [
\ 'validate.yml:19:9: shellcheck reported issue in this script: SC2086:info:1:15: Double quote to prevent globbing and word splitting [shellcheck]'
\ ])

Execute(Command should always have -no-color and -oneline options):
let g:ale_yaml_actionlint_options = ''

Expand Down