From 47d941b491844153304b3c87664f847df9d5dae4 Mon Sep 17 00:00:00 2001 From: Ian2020 Date: Fri, 24 Apr 2020 11:39:45 +0100 Subject: Add shellcheck as linter for bats files --- ale_linters/bats/shellcheck.vim | 78 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 ale_linters/bats/shellcheck.vim (limited to 'ale_linters/bats/shellcheck.vim') diff --git a/ale_linters/bats/shellcheck.vim b/ale_linters/bats/shellcheck.vim new file mode 100644 index 00000000..64130a2d --- /dev/null +++ b/ale_linters/bats/shellcheck.vim @@ -0,0 +1,78 @@ +" Author: Ian2020 +" Description: This file adds support for using the shellcheck linter with +" bats scripts. Heavily inspired by/copied from work by w0rp on shellcheck +" for sh files. + +" This global variable can be set with a string of comma-separated error +" codes to exclude from shellcheck. For example: +" +" let g:ale_bats_shellcheck_exclusions = 'SC2002,SC2004' +call ale#Set('bats_shellcheck_exclusions', get(g:, 'ale_linters_bats_shellcheck_exclusions', '')) +call ale#Set('bats_shellcheck_executable', 'shellcheck') +call ale#Set('bats_shellcheck_options', '') +call ale#Set('bats_shellcheck_change_directory', 1) + +function! ale_linters#bats#shellcheck#GetCommand(buffer, version) abort + let l:options = ale#Var(a:buffer, 'bats_shellcheck_options') + let l:exclude_option = ale#Var(a:buffer, 'bats_shellcheck_exclusions') + let l:external_option = ale#semver#GTE(a:version, [0, 4, 0]) ? ' -x' : '' + let l:cd_string = ale#Var(a:buffer, 'bats_shellcheck_change_directory') + \ ? ale#path#BufferCdString(a:buffer) + \ : '' + + return l:cd_string + \ . '%e' + \ . ' -s bats' + \ . (!empty(l:options) ? ' ' . l:options : '') + \ . (!empty(l:exclude_option) ? ' -e ' . l:exclude_option : '') + \ . l:external_option + \ . ' -f gcc -' +endfunction + +function! ale_linters#bats#shellcheck#Handle(buffer, lines) abort + let l:pattern = '\v^([a-zA-Z]?:?[^:]+):(\d+):(\d+)?:? ([^:]+): (.+) \[([^\]]+)\]$' + let l:output = [] + + for l:match in ale#util#GetMatches(a:lines, l:pattern) + if l:match[4] is# 'error' + let l:type = 'E' + elseif l:match[4] is# 'note' + let l:type = 'I' + else + let l:type = 'W' + endif + + let l:item = { + \ 'lnum': str2nr(l:match[2]), + \ 'type': l:type, + \ 'text': l:match[5], + \ 'code': l:match[6], + \} + + if !empty(l:match[3]) + let l:item.col = str2nr(l:match[3]) + endif + + " If the filename is something like , or -, then + " this is an error for the file we checked. + if l:match[1] isnot# '-' && l:match[1][0] isnot# '<' + let l:item['filename'] = l:match[1] + endif + + call add(l:output, l:item) + endfor + + return l:output +endfunction + +call ale#linter#Define('bats', { +\ 'name': 'shellcheck', +\ 'executable': {buffer -> ale#Var(buffer, 'bats_shellcheck_executable')}, +\ 'command': {buffer -> ale#semver#RunWithVersionCheck( +\ buffer, +\ ale#Var(buffer, 'bats_shellcheck_executable'), +\ '%e --version', +\ function('ale_linters#bats#shellcheck#GetCommand'), +\ )}, +\ 'callback': 'ale_linters#bats#shellcheck#Handle', +\}) -- cgit v1.2.3 From d4e1c57026395c53547e18ab290fc588e0645d22 Mon Sep 17 00:00:00 2001 From: Ian2020 Date: Tue, 28 Apr 2020 17:46:15 +0100 Subject: Moved common code to ale handlers, updated bats doc --- ale_linters/bats/shellcheck.vim | 73 ++--------------------------------------- 1 file changed, 3 insertions(+), 70 deletions(-) (limited to 'ale_linters/bats/shellcheck.vim') diff --git a/ale_linters/bats/shellcheck.vim b/ale_linters/bats/shellcheck.vim index 64130a2d..b5a1184b 100644 --- a/ale_linters/bats/shellcheck.vim +++ b/ale_linters/bats/shellcheck.vim @@ -3,76 +3,9 @@ " bats scripts. Heavily inspired by/copied from work by w0rp on shellcheck " for sh files. -" This global variable can be set with a string of comma-separated error -" codes to exclude from shellcheck. For example: -" -" let g:ale_bats_shellcheck_exclusions = 'SC2002,SC2004' -call ale#Set('bats_shellcheck_exclusions', get(g:, 'ale_linters_bats_shellcheck_exclusions', '')) -call ale#Set('bats_shellcheck_executable', 'shellcheck') -call ale#Set('bats_shellcheck_options', '') -call ale#Set('bats_shellcheck_change_directory', 1) - -function! ale_linters#bats#shellcheck#GetCommand(buffer, version) abort - let l:options = ale#Var(a:buffer, 'bats_shellcheck_options') - let l:exclude_option = ale#Var(a:buffer, 'bats_shellcheck_exclusions') - let l:external_option = ale#semver#GTE(a:version, [0, 4, 0]) ? ' -x' : '' - let l:cd_string = ale#Var(a:buffer, 'bats_shellcheck_change_directory') - \ ? ale#path#BufferCdString(a:buffer) - \ : '' - - return l:cd_string - \ . '%e' - \ . ' -s bats' - \ . (!empty(l:options) ? ' ' . l:options : '') - \ . (!empty(l:exclude_option) ? ' -e ' . l:exclude_option : '') - \ . l:external_option - \ . ' -f gcc -' -endfunction - -function! ale_linters#bats#shellcheck#Handle(buffer, lines) abort - let l:pattern = '\v^([a-zA-Z]?:?[^:]+):(\d+):(\d+)?:? ([^:]+): (.+) \[([^\]]+)\]$' - let l:output = [] - - for l:match in ale#util#GetMatches(a:lines, l:pattern) - if l:match[4] is# 'error' - let l:type = 'E' - elseif l:match[4] is# 'note' - let l:type = 'I' - else - let l:type = 'W' - endif - - let l:item = { - \ 'lnum': str2nr(l:match[2]), - \ 'type': l:type, - \ 'text': l:match[5], - \ 'code': l:match[6], - \} - - if !empty(l:match[3]) - let l:item.col = str2nr(l:match[3]) - endif - - " If the filename is something like , or -, then - " this is an error for the file we checked. - if l:match[1] isnot# '-' && l:match[1][0] isnot# '<' - let l:item['filename'] = l:match[1] - endif - - call add(l:output, l:item) - endfor - - return l:output -endfunction - call ale#linter#Define('bats', { \ 'name': 'shellcheck', -\ 'executable': {buffer -> ale#Var(buffer, 'bats_shellcheck_executable')}, -\ 'command': {buffer -> ale#semver#RunWithVersionCheck( -\ buffer, -\ ale#Var(buffer, 'bats_shellcheck_executable'), -\ '%e --version', -\ function('ale_linters#bats#shellcheck#GetCommand'), -\ )}, -\ 'callback': 'ale_linters#bats#shellcheck#Handle', +\ 'executable': function('ale#handlers#shellcheck#GetExecutable'), +\ 'command': function('ale#handlers#shellcheck#GetCommand'), +\ 'callback': 'ale#handlers#shellcheck#Handle', \}) -- cgit v1.2.3 From ca97f32258cc6e3f32b5f7605801f053e7dbe320 Mon Sep 17 00:00:00 2001 From: Ian2020 Date: Fri, 8 May 2020 12:55:54 +0100 Subject: Use a function to define shellcheck linters and vars needed, fixes tests --- ale_linters/bats/shellcheck.vim | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) (limited to 'ale_linters/bats/shellcheck.vim') diff --git a/ale_linters/bats/shellcheck.vim b/ale_linters/bats/shellcheck.vim index b5a1184b..5c2a0ea9 100644 --- a/ale_linters/bats/shellcheck.vim +++ b/ale_linters/bats/shellcheck.vim @@ -1,11 +1,4 @@ " Author: Ian2020 -" Description: This file adds support for using the shellcheck linter with -" bats scripts. Heavily inspired by/copied from work by w0rp on shellcheck -" for sh files. +" Description: shellcheck linter for bats scripts. -call ale#linter#Define('bats', { -\ 'name': 'shellcheck', -\ 'executable': function('ale#handlers#shellcheck#GetExecutable'), -\ 'command': function('ale#handlers#shellcheck#GetCommand'), -\ 'callback': 'ale#handlers#shellcheck#Handle', -\}) +call ale#handlers#shellcheck#DefineLinter('bats') -- cgit v1.2.3