#869 - Detect the shell dialect from the hashbang for shellcheck

This commit is contained in:
w0rp
2017-08-28 19:16:23 +01:00
parent 73ec83d055
commit 5a88395bbb
5 changed files with 173 additions and 21 deletions

View File

@@ -0,0 +1,47 @@
Before:
Save g:ale_sh_shellcheck_exclusions
Save g:ale_sh_shellcheck_executable
Save g:ale_sh_shellcheck_options
unlet! g:ale_sh_shellcheck_exclusions
unlet! g:ale_sh_shellcheck_executable
unlet! g:ale_sh_shellcheck_options
runtime ale_linters/sh/shellcheck.vim
After:
Restore
unlet! b:ale_sh_shellcheck_exclusions
unlet! b:ale_sh_shellcheck_executable
unlet! b:ale_sh_shellcheck_options
unlet! b:is_bash
call ale#linter#Reset()
Execute(The default shellcheck command should be correct):
AssertEqual
\ 'shellcheck -f gcc -',
\ ale_linters#sh#shellcheck#GetCommand(bufnr(''))
Execute(The shellcheck command should accept options):
let b:ale_sh_shellcheck_options = '--foobar'
AssertEqual
\ 'shellcheck --foobar -f gcc -',
\ ale_linters#sh#shellcheck#GetCommand(bufnr(''))
Execute(The shellcheck command should accept options and exclusions):
let b:ale_sh_shellcheck_options = '--foobar'
let b:ale_sh_shellcheck_exclusions = 'foo,bar'
AssertEqual
\ 'shellcheck --foobar -e foo,bar -f gcc -',
\ ale_linters#sh#shellcheck#GetCommand(bufnr(''))
Execute(The shellcheck command should include the dialect):
let b:is_bash = 1
AssertEqual
\ 'shellcheck -s bash -f gcc -',
\ ale_linters#sh#shellcheck#GetCommand(bufnr(''))

View File

@@ -0,0 +1,83 @@
Before:
runtime ale_linters/sh/shell.vim
runtime ale_linters/sh/shellcheck.vim
After:
call ale#linter#Reset()
unlet! b:is_bash
unlet! b:is_sh
unlet! b:is_kornshell
Given(A file with a Bash hashbang):
#!/bin/bash
Execute(/bin/bash should be detected appropriately):
AssertEqual 'bash', ale#handlers#sh#GetShellType(bufnr(''))
AssertEqual 'bash', ale_linters#sh#shell#GetExecutable(bufnr(''))
AssertEqual 'bash', ale_linters#sh#shellcheck#GetDialectArgument(bufnr(''))
Given(A file with /bin/sh):
#!/usr/bin/env sh -eu --foobar
Execute(/bin/sh should be detected appropriately):
AssertEqual 'sh', ale#handlers#sh#GetShellType(bufnr(''))
AssertEqual 'sh', ale_linters#sh#shell#GetExecutable(bufnr(''))
AssertEqual 'sh', ale_linters#sh#shellcheck#GetDialectArgument(bufnr(''))
Given(A file with bash as an argument to env):
#!/usr/bin/env bash
Execute(/usr/bin/env bash should be detected appropriately):
AssertEqual 'bash', ale#handlers#sh#GetShellType(bufnr(''))
AssertEqual 'bash', ale_linters#sh#shell#GetExecutable(bufnr(''))
AssertEqual 'bash', ale_linters#sh#shellcheck#GetDialectArgument(bufnr(''))
Given(A file with a tcsh hash bang and arguments):
#!/usr/bin/env tcsh -eu --foobar
Execute(tcsh should be detected appropriately):
AssertEqual 'tcsh', ale#handlers#sh#GetShellType(bufnr(''))
AssertEqual 'tcsh', ale_linters#sh#shell#GetExecutable(bufnr(''))
AssertEqual 'tcsh', ale_linters#sh#shellcheck#GetDialectArgument(bufnr(''))
Given(A file with a zsh hash bang and arguments):
#!/usr/bin/env zsh -eu --foobar
Execute(zsh should be detected appropriately):
AssertEqual 'zsh', ale#handlers#sh#GetShellType(bufnr(''))
AssertEqual 'zsh', ale_linters#sh#shell#GetExecutable(bufnr(''))
AssertEqual 'zsh', ale_linters#sh#shellcheck#GetDialectArgument(bufnr(''))
Given(A file with a csh hash bang and arguments):
#!/usr/bin/env csh -eu --foobar
Execute(zsh should be detected appropriately):
AssertEqual 'csh', ale#handlers#sh#GetShellType(bufnr(''))
AssertEqual 'csh', ale_linters#sh#shell#GetExecutable(bufnr(''))
AssertEqual 'csh', ale_linters#sh#shellcheck#GetDialectArgument(bufnr(''))
Given(A file with a sh hash bang and arguments):
#!/usr/bin/env sh -eu --foobar
Execute(sh should be detected appropriately):
AssertEqual 'sh', ale#handlers#sh#GetShellType(bufnr(''))
AssertEqual 'sh', ale_linters#sh#shell#GetExecutable(bufnr(''))
AssertEqual 'sh', ale_linters#sh#shellcheck#GetDialectArgument(bufnr(''))
Given(A file without a hashbang):
Execute(The bash dialect should be used for shellcheck if b:is_bash is 1):
let b:is_bash = 1
AssertEqual 'bash', ale_linters#sh#shellcheck#GetDialectArgument(bufnr(''))
Execute(The sh dialect should be used for shellcheck if b:is_sh is 1):
let b:is_sh = 1
AssertEqual 'sh', ale_linters#sh#shellcheck#GetDialectArgument(bufnr(''))
Execute(The ksh dialect should be used for shellcheck if b:is_kornshell is 1):
let b:is_kornshell = 1
AssertEqual 'ksh', ale_linters#sh#shellcheck#GetDialectArgument(bufnr(''))