Add shellcheck github workflow (#190)

* Add shellcheck github workflow

* Fix shellcheck

* Remove shellcheck exceptions

.github/workflows/shellcheck.yml

@@ -0,0 +1,18 @@
+name: shellcheck
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  shellcheck:
+    name: Run shellcheck on scripts
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332
+
+      - name: Run shellcheck
+        uses: ludeeus/action-shellcheck@00cae500b08a931fb5698e11e79bfbd38e612a38

bin/bootstrap

@@ -45,9 +45,10 @@ system("rm -rf %s" % File.join(dir, ".git"))
 system("rm -rf %s" % File.join(dir, "Gemfile"))
 system("rm -rf %s" % File.join(dir, "Gemfile.lock"))
 system("rm -rf %s" % File.join(dir, ".ruby-version"))
-system("rm -rf %s" % File.join(dir, "bin/bootstrap"))
-system("rm -rf %s" % File.join(dir, ".github/ISSUE_TEMPLATE.md"))
-system("rm -rf %s" % File.join(dir, ".github/workflows/pause-community-contributions.yml"))
+system("rm -rf %s" % File.join(dir, "bin", "bootstrap"))
+system("rm -rf %s" % File.join(dir, ".github", "ISSUE_TEMPLATE.md"))
+system("rm -rf %s" % File.join(dir, ".github", "workflows", "pause-community-contributions.yml"))
+system("rm -rf %s" % File.join(dir, ".github", "workflows", "shellcheck.yml"))
 system("mv %s/TRACK_README.md %s/README.md" % [dir, dir])
 
 f = File.join(dir, 'LICENSE')
@@ -62,6 +63,14 @@ File.open(f, "w") do |f|
   f.write contents.gsub('{{UUID}}') {|m| SecureRandom.uuid }
 end
 
+%w[verify-exercises verify-exercises-in-docker].each do |name|
+  f = File.join(dir, 'bin', name)
+  contents = File.read(f)
+  File.open(f, "w") do |f|
+    f.write contents.gsub(/^\s*# shellcheck.*?\n/, '')
+  end
+end
+
 [
   "config.json",
   "README.md",

bin/verify-exercises

@@ -29,6 +29,7 @@ copy_example_or_examplar_to_solution() {
 }
 
 unskip_tests() {
+    # shellcheck disable=SC2034
     jq -r '.files.test[]' .meta/config.json | while read -r test_file; do
         noop # TODO: replace this with the command to unskip the tests.
         # Note: this function runs from within an exercise directory.

bin/verify-exercises-in-docker

@@ -30,6 +30,7 @@ copy_example_or_examplar_to_solution() {
 }
 
 pull_docker_image() {
+    # shellcheck disable=SC1083
     docker pull exercism/{{SLUG}}-test-runner ||
         die $'Could not find the `exercism/{{SLUG}}-test-runner` Docker image.\nCheck the test runner docs at https://exercism.org/docs/building/tooling/test-runners for more information.'
 }
@@ -38,6 +39,7 @@ run_tests() {
     local slug
     slug="${1}"
 
+    # shellcheck disable=SC1083
     docker run \
         --rm \
         --network none \