Moved common code to ale handlers, updated bats doc

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 <stdin>, <nofile> 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')},
+\   'executable':  function('ale#handlers#shellcheck#GetExecutable'),
-\   'command': {buffer -> ale#semver#RunWithVersionCheck(
+\   'command': function('ale#handlers#shellcheck#GetCommand'),
-\       buffer,
+\   'callback': 'ale#handlers#shellcheck#Handle',
-\       ale#Var(buffer, 'bats_shellcheck_executable'),
-\       '%e --version',
-\       function('ale_linters#bats#shellcheck#GetCommand'),
-\   )},
-\   'callback': 'ale_linters#bats#shellcheck#Handle',
 \})

ale_linters/sh/shellcheck.vim

@@ -2,106 +2,9 @@
 " Description: This file adds support for using the shellcheck linter with
 "   shell scripts.
 
-" This global variable can be set with a string of comma-separated error
-" codes to exclude from shellcheck. For example:
-"
-" let g:ale_sh_shellcheck_exclusions = 'SC2002,SC2004'
-call ale#Set('sh_shellcheck_exclusions', get(g:, 'ale_linters_sh_shellcheck_exclusions', ''))
-call ale#Set('sh_shellcheck_executable', 'shellcheck')
-call ale#Set('sh_shellcheck_dialect', 'auto')
-call ale#Set('sh_shellcheck_options', '')
-call ale#Set('sh_shellcheck_change_directory', 1)
-
-function! ale_linters#sh#shellcheck#GetDialectArgument(buffer) abort
-    let l:shell_type = ale#handlers#sh#GetShellType(a:buffer)
-
-    if !empty(l:shell_type)
-        " Use the dash dialect for /bin/ash, etc.
-        if l:shell_type is# 'ash'
-            return 'dash'
-        endif
-
-        return l:shell_type
-    endif
-
-    " If there's no hashbang, try using Vim's buffer variables.
-    if getbufvar(a:buffer, 'is_bash', 0)
-        return 'bash'
-    elseif getbufvar(a:buffer, 'is_sh', 0)
-        return 'sh'
-    elseif getbufvar(a:buffer, 'is_kornshell', 0)
-        return 'ksh'
-    endif
-
-    return ''
-endfunction
-
-function! ale_linters#sh#shellcheck#GetCommand(buffer, version) abort
-    let l:options = ale#Var(a:buffer, 'sh_shellcheck_options')
-    let l:exclude_option = ale#Var(a:buffer, 'sh_shellcheck_exclusions')
-    let l:dialect = ale#Var(a:buffer, 'sh_shellcheck_dialect')
-    let l:external_option = ale#semver#GTE(a:version, [0, 4, 0]) ? ' -x' : ''
-    let l:cd_string = ale#Var(a:buffer, 'sh_shellcheck_change_directory')
-    \   ? ale#path#BufferCdString(a:buffer)
-    \   : ''
-
-    if l:dialect is# 'auto'
-        let l:dialect = ale_linters#sh#shellcheck#GetDialectArgument(a:buffer)
-    endif
-
-    return l:cd_string
-    \   . '%e'
-    \   . (!empty(l:dialect) ? ' -s ' . l:dialect : '')
-    \   . (!empty(l:options) ? ' ' . l:options : '')
-    \   . (!empty(l:exclude_option) ? ' -e ' . l:exclude_option : '')
-    \   . l:external_option
-    \   . ' -f gcc -'
-endfunction
-
-function! ale_linters#sh#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 <stdin>, <nofile> 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('sh', {
 \   'name': 'shellcheck',
-\   'executable': {buffer -> ale#Var(buffer, 'sh_shellcheck_executable')},
+\   'executable':  function('ale#handlers#shellcheck#GetExecutable'),
-\   'command': {buffer -> ale#semver#RunWithVersionCheck(
+\   'command': function('ale#handlers#shellcheck#GetCommand'),
-\       buffer,
+\   'callback': 'ale#handlers#shellcheck#Handle',
-\       ale#Var(buffer, 'sh_shellcheck_executable'),
-\       '%e --version',
-\       function('ale_linters#sh#shellcheck#GetCommand'),
-\   )},
-\   'callback': 'ale_linters#sh#shellcheck#Handle',
 \})

autoload/ale/handlers/shellcheck.vim

@@ -0,0 +1,107 @@
+" Author: w0rp <devw0rp@gmail.com>
+" Description: This file adds support for using the shellcheck linter with
+"   shell scripts.
+
+" This global variable can be set with a string of comma-separated error
+" codes to exclude from shellcheck. For example:
+"
+" let g:ale_sh_shellcheck_exclusions = 'SC2002,SC2004'
+call ale#Set('sh_shellcheck_exclusions', get(g:, 'ale_linters_sh_shellcheck_exclusions', ''))
+call ale#Set('sh_shellcheck_executable', 'shellcheck')
+call ale#Set('sh_shellcheck_dialect', 'auto')
+call ale#Set('sh_shellcheck_options', '')
+call ale#Set('sh_shellcheck_change_directory', 1)
+
+function! ale#handlers#shellcheck#GetDialectArgument(buffer) abort
+    let l:shell_type = ale#handlers#sh#GetShellType(a:buffer)
+
+    if !empty(l:shell_type)
+        " Use the dash dialect for /bin/ash, etc.
+        if l:shell_type is# 'ash'
+            return 'dash'
+        endif
+
+        return l:shell_type
+    endif
+
+    " If there's no hashbang, try using Vim's buffer variables.
+    if getbufvar(a:buffer, 'is_bash', 0)
+        return 'bash'
+    elseif getbufvar(a:buffer, 'is_sh', 0)
+        return 'sh'
+    elseif getbufvar(a:buffer, 'is_kornshell', 0)
+        return 'ksh'
+    endif
+
+    return ''
+endfunction
+
+function! ale#handlers#shellcheck#GetCommandWithVersion(buffer, version) abort
+    let l:options = ale#Var(a:buffer, 'sh_shellcheck_options')
+    let l:exclude_option = ale#Var(a:buffer, 'sh_shellcheck_exclusions')
+    let l:dialect = ale#Var(a:buffer, 'sh_shellcheck_dialect')
+    let l:external_option = ale#semver#GTE(a:version, [0, 4, 0]) ? ' -x' : ''
+    let l:cd_string = ale#Var(a:buffer, 'sh_shellcheck_change_directory')
+    \   ? ale#path#BufferCdString(a:buffer)
+    \   : ''
+
+    if l:dialect is# 'auto'
+        let l:dialect = ale#handlers#shellcheck#GetDialectArgument(a:buffer)
+    endif
+
+    return l:cd_string
+    \   . '%e'
+    \   . (!empty(l:dialect) ? ' -s ' . l:dialect : '')
+    \   . (!empty(l:options) ? ' ' . l:options : '')
+    \   . (!empty(l:exclude_option) ? ' -e ' . l:exclude_option : '')
+    \   . l:external_option
+    \   . ' -f gcc -'
+endfunction
+
+function! ale#handlers#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 <stdin>, <nofile> 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
+
+function! ale#handlers#shellcheck#GetExecutable(buffer) abort
+    return ale#Var(a:buffer, 'sh_shellcheck_executable')
+endfunction
+
+function! ale#handlers#shellcheck#GetCommand(buffer) abort
+    return ale#semver#RunWithVersionCheck(a:buffer,
+\       ale#Var(a:buffer, 'sh_shellcheck_executable'),
+\       '%e --version',
+\       function('ale#handlers#shellcheck#GetCommandWithVersion'),
+\   )
+endfunction

doc/ale-bats.txt

@@ -5,44 +5,9 @@ ALE Bats Integration                                           *ale-bats-options
 ===============================================================================
 shellcheck                                                  *ale-bats-shellcheck*
 
-g:ale_bats_shellcheck_executable               *g:ale_bats_shellcheck_executable*
+The `shellcheck` linter for Bats uses the sh options for `shellcheck`; see:
-                                               *b:ale_bats_shellcheck_executable*
+|ale-sh-shellcheck|.
-  Type: |String|
-  Default: `'shellcheck'`
 
-  This variable sets executable used for shellcheck.
-
-
-g:ale_bats_shellcheck_options                     *g:ale_bats_shellcheck_options*
-                                                  *b:ale_bats_shellcheck_options*
-  Type: |String|
-  Default: `''`
-
-  With this variable we are able to pass extra arguments for shellcheck
-  for shellcheck invocation.
-
-  For example, if we want shellcheck to follow external sources (`see SC1091`)
-  we can set the variable as such:
->
-  let g:ale_bats_shellcheck_options = '-x'
-<
-
-
-g:ale_bats_shellcheck_change_directory   *g:ale_bats_shellcheck_change_directory*
-                                         *b:ale_bats_shellcheck_change_directory*
-  Type: |Number|
-  Default: `1`
-
-  If set to `1`, ALE will switch to the directory the shell file being
-  checked with `shellcheck` is in before checking it. This helps `shellcheck`
-  determine the path to sourced files more easily. This option can be turned
-  off if you want to control the directory `shellcheck` is executed from
-  yourself.
-
-
-    autocmd BufEnter PKGBUILD,.env
-    \   let b:ale_bats_shellcheck_exclusions = 'SC2034,SC2154,SC2164'
-<
 
 ===============================================================================
   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: