RepoMirrors
/
ale
mirror of https://github.com/dense-analysis/ale
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
ale/ale_linters/sh/shellcheck.vim

53 lines
1.6 KiB
VimL
Raw Normal View History

Add support for shellcheck linting.
2016-10-03 12:18:27 +00:00
" 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-seperated error
" codes to exclude from shellcheck. For example:
"
" let g:ale_linters_sh_shellcheck_exclusions = 'SC2002,SC2004'
if !exists('g:ale_linters_sh_shellcheck_exclusions')
let g:ale_linters_sh_shellcheck_exclusions = ''
endif
added shellcheck executable and options variable updated docs
2017-04-09 17:54:25 +00:00
let g:ale_sh_shellcheck_executable =
\ get(g:, 'ale_sh_shellcheck_executable', 'shellcheck')
let g:ale_sh_shellcheck_options =
\ get(g:, 'ale_sh_shellcheck_options', '')
function! ale_linters#sh#shellcheck#GetExecutable(buffer) abort
return g:ale_sh_shellcheck_executable
endfunction
Correct all Vint warnings
2016-10-08 22:55:58 +00:00
if g:ale_linters_sh_shellcheck_exclusions !=# ''
Add support for shellcheck linting.
2016-10-03 12:18:27 +00:00
let s:exclude_option = '-e ' . g:ale_linters_sh_shellcheck_exclusions
else
let s:exclude_option = ''
endif
Add a script for custom checks to enforce using the abort flag for functions and trailing whitespace, and fix existing issues.
2017-01-22 14:54:57 +00:00
function! s:GetDialectArgument() abort
Choose shell dialect based on vim syntax Shellcheck is smart enough to check the shebang in a given file to determine which dialect to use. Unfortunately this doesn't work for files without shebangs, even if it might be apparent what dialect should be used, such as "bashrc" or "foo.bash". Luckily `filetype.vim` defines specific vars based on which shell dialect is being used based on a huge list of conditions. With this change we take those into account for all the types shellcheck supports, otherwise we fallback to letting it try and decide.
2016-10-27 08:20:22 +00:00
if exists('b:is_bash') && b:is_bash
return '-s bash'
elseif exists('b:is_sh') && b:is_sh
return '-s sh'
elseif exists('b:is_kornshell') && b:is_kornshell
return '-s ksh'
endif
return ''
endfunction
Add a script for custom checks to enforce using the abort flag for functions and trailing whitespace, and fix existing issues.
2017-01-22 14:54:57 +00:00
function! ale_linters#sh#shellcheck#GetCommand(buffer) abort
added shellcheck executable and options variable updated docs
2017-04-09 17:54:25 +00:00
return ale_linters#sh#shellcheck#GetExecutable(a:buffer)
\ . ' ' . g:ale_sh_shellcheck_options
\ . ' ' . s:exclude_option . ' ' . s:GetDialectArgument() . ' -f gcc -'
Choose shell dialect based on vim syntax Shellcheck is smart enough to check the shebang in a given file to determine which dialect to use. Unfortunately this doesn't work for files without shebangs, even if it might be apparent what dialect should be used, such as "bashrc" or "foo.bash". Luckily `filetype.vim` defines specific vars based on which shell dialect is being used based on a huge list of conditions. With this change we take those into account for all the types shellcheck supports, otherwise we fallback to letting it try and decide.
2016-10-27 08:20:22 +00:00
endfunction
First pass at optimizing ale to autoload (#80) * First pass at optimizing ale to autoload First off, the structure/function names should be revised a bit, but I will wait for @w0rp's input before unifying the naming style. Second off, the docs probably need some more work, I just did some simple find-and-replace work. With that said, this pull brings major performance gains for ale. On my slowest system, fully loading ale and all its code takes around 150ms. I have moved all of ale's autoload-able code to autoload/, and in addition, implemented lazy-loading of linters. This brings load time on that same system down to 5ms. The only downside of lazy loading is that `g:ale_linters` cannot be changed at runtime; however, it also speeds up performance at runtime by simplfying the logic greatly. Please let me know what you think! Closes #59 * Address Travis/Vint errors For some reason, ale isn't running vint for me... * Incorporate feedback, make fixes Lazy-loading logic is much improved. * Add header comments; remove incorrect workaround * Remove unneeded plugin guards * Fix lazy-loading linter logic Set the wrong variable.... * Fix capitialization
2016-10-10 18:51:29 +00:00
call ale#linter#Define('sh', {
Add support for shellcheck linting.
2016-10-03 12:18:27 +00:00
\ 'name': 'shellcheck',
added shellcheck executable and options variable updated docs
2017-04-09 17:54:25 +00:00
\ 'executable_callback': 'ale_linters#sh#shellcheck#GetExecutable',
Choose shell dialect based on vim syntax Shellcheck is smart enough to check the shebang in a given file to determine which dialect to use. Unfortunately this doesn't work for files without shebangs, even if it might be apparent what dialect should be used, such as "bashrc" or "foo.bash". Luckily `filetype.vim` defines specific vars based on which shell dialect is being used based on a huge list of conditions. With this change we take those into account for all the types shellcheck supports, otherwise we fallback to letting it try and decide.
2016-10-27 08:20:22 +00:00
\ 'command_callback': 'ale_linters#sh#shellcheck#GetCommand',
Add support for shellcheck linting.
2016-10-03 12:18:27 +00:00
\ 'callback': 'ale#handlers#HandleGCCFormat',
\})