Merge pull request #12 from durkode/master

Passing options to shellcheck

Author: lox

hooks/command

@@ -34,8 +34,11 @@ if [[ -z ${files:-} ]] ; then
   exit 1
 fi
 
+# Read in the options to pass to shellcheck
+mapfile -t options<<<"$(plugin_read_list OPTIONS)"
+
 echo "+++ Running shellcheck on ${#files[@]} files"
-if docker run --rm -v "$PWD:/mnt" --workdir "/mnt" koalaman/shellcheck "${files[@]}" ; then
+if docker run --rm -v "$PWD:/mnt" --workdir "/mnt" koalaman/shellcheck "${options[@]+${options[@]}}" "${files[@]}" ; then
   echo "Files are ok ✅"
 else
   exit 1

plugin.yml

@@ -9,5 +9,8 @@ configuration:
     files:
       type: [string, array]
       minItems: 1
+    options:
+      type: [string, array]
+      minItems: 1
   required:
     - files

tests/run.bats

@@ -34,6 +34,57 @@ load '/usr/local/lib/bats/load.bash'
   unstub docker
 }
 
+@test "Shellcheck a single file with single option" {
+  export BUILDKITE_PLUGIN_SHELLCHECK_FILES_0="tests/testdata/subdir/llamas.sh"
+  export BUILDKITE_PLUGIN_SHELLCHECK_OPTIONS_0="--exclude=SC2086"
+
+  stub docker \
+    "run --rm -v $PWD:/mnt --workdir /mnt koalaman/shellcheck --exclude=SC2086 tests/testdata/subdir/llamas.sh : echo testing llamas.sh"
+
+  run "$PWD/hooks/command"
+
+  assert_success
+  assert_output --partial "testing llamas.sh"
+
+  unstub docker
+}
+
+@test "Shellcheck a single file with multiple options" {
+  export BUILDKITE_PLUGIN_SHELLCHECK_FILES_0="tests/testdata/subdir/llamas.sh"
+  export BUILDKITE_PLUGIN_SHELLCHECK_OPTIONS_0="--exclude=SC2086"
+  export BUILDKITE_PLUGIN_SHELLCHECK_OPTIONS_1="--format=gcc"
+  export BUILDKITE_PLUGIN_SHELLCHECK_OPTIONS_2="-x"
+
+  stub docker \
+    "run --rm -v $PWD:/mnt --workdir /mnt koalaman/shellcheck --exclude=SC2086 --format=gcc -x tests/testdata/subdir/llamas.sh : echo testing llamas.sh"
+
+  run "$PWD/hooks/command"
+
+  assert_success
+  assert_output --partial "testing llamas.sh"
+
+  unstub docker
+}
+
+@test "Shellcheck multiple files with multiple options" {
+  export BUILDKITE_PLUGIN_SHELLCHECK_FILES_0="tests/testdata/test.sh"
+  export BUILDKITE_PLUGIN_SHELLCHECK_FILES_1="tests/testdata/subdir/*"
+  export BUILDKITE_PLUGIN_SHELLCHECK_FILES_2="missing"
+  export BUILDKITE_PLUGIN_SHELLCHECK_OPTIONS_0="--exclude=SC2086"
+  export BUILDKITE_PLUGIN_SHELLCHECK_OPTIONS_1="--format=gcc"
+  export BUILDKITE_PLUGIN_SHELLCHECK_OPTIONS_2="-x"
+
+  stub docker \
+    "run --rm -v $PWD:/mnt --workdir /mnt koalaman/shellcheck --exclude=SC2086 --format=gcc -x tests/testdata/test.sh tests/testdata/subdir/llamas.sh tests/testdata/subdir/shell\ with\ space.sh' : echo testing test.sh"
+
+  run "$PWD/hooks/command"
+
+  assert_success
+  assert_output --partial "testing test.sh"
+
+  unstub docker
+}
+
 @test "Shellcheck failure" {
   export BUILDKITE_PLUGIN_SHELLCHECK_FILES_0="tests/testdata/subdir/llamas.sh"