Add shellcheck pre-commit hook

Convert the shellcheck test from a test to a pre-commit hook
this prevents needing to updated the docker file every time
there is an update to shellcheck.

Author: admorgan

.github/workflows/pre-commit.yml

@@ -0,0 +1,13 @@
+name: pre-commit
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v3
+    - uses: pre-commit/[email protected]

.pre-commit-config.yaml

@@ -10,3 +10,12 @@ repos:
     -   id: check-executables-have-shebangs
     -   id: check-shebang-scripts-are-executable
         exclude: \.t$
+-   repo: https://github.com/koalaman/shellcheck-precommit
+    rev: v0.10.0
+    hooks:
+    -   id: shellcheck
+        args: [-x]
+        exclude: |
+             (?x)^(ext/.*|
+                 share/git-completion.bash
+             )$

note/init-test

@@ -13,19 +13,19 @@ git clone "[email protected]:$repo" test-repo
 
 (
   # cd into test-repo
-  cd test-repo
+  cd test-repo || exit
   # Tag original head
   git tag o
   # Pick a commit in the middle of the commit history
   S=$(git rev-parse HEAD^^^^)
   # Reset to the middle commit
-  git reset --hard $S
+  git reset --hard "$S"
   # Tag that history as 'a'
   git tag a
   # Reset to original
   git reset --hard o
   # Take the tail of the history.
-  git filter-branch -f --parent-filter "sed 's/-p $S//'" $S..HEAD
+  git filter-branch -f --parent-filter "sed 's/-p $S//'" "$S..HEAD"
   # Mark that sequence as 'b'
   git tag b
   # Reset to a

note/test.sh

@@ -162,10 +162,12 @@ sub generate_bash {
     local _opts="$options_string"
     local subcommands="@$list"
     local subdircommands="@$subdir_cmds"
-    local subcommand="\$(__git_find_on_cmdline "\$subcommands")"
+    local subcommand
+    subcommand="\$(__git_find_on_cmdline "\$subcommands")"
 
     if [ -z "\$subcommand" ]; then
         # no subcommand yet
+        # shellcheck disable=SC2154
         case "\$cur" in
         -*)
             __gitcomp "\$_opts"
@@ -188,9 +190,11 @@ sub generate_bash {
             return
         fi
 
-        local subdircommand="\$(__git_find_on_cmdline "\$subdircommands")"
-        if [ ! -z "\$subdircommand" ]; then
-            local git_subrepos=`git subrepo status -q`
+        local subdircommand
+        subdircommand="\$(__git_find_on_cmdline "\$subdircommands")"
+        if [ -n "\$subdircommand" ]; then
+            local git_subrepos
+            git_subrepos=$(git subrepo status -q)
             __gitcomp "\$git_subrepos"
         fi
 

pkg/bin/generate-completion.pl

@@ -4,10 +4,12 @@ _git_subrepo() {
     local _opts=" -h --help --version -a --all -A --ALL -b= --branch= -e --edit -f --force -F --fetch -M= --method= -m= --message= --file= -r= --remote= -s --squash -u --update -q --quiet -v --verbose -d --debug -x --DEBUG"
     local subcommands="branch clean clone commit config fetch help init pull push status upgrade version"
     local subdircommands="branch clean commit config fetch pull push status"
-    local subcommand="$(__git_find_on_cmdline "$subcommands")"
+    local subcommand
+    subcommand="$(__git_find_on_cmdline "$subcommands")"
 
     if [ -z "$subcommand" ]; then
         # no subcommand yet
+        # shellcheck disable=SC2154
         case "$cur" in
         -*)
             __gitcomp "$_opts"
@@ -30,9 +32,11 @@ _git_subrepo() {
             return
         fi
 
-        local subdircommand="$(__git_find_on_cmdline "$subdircommands")"
-        if [ ! -z "$subdircommand" ]; then
-            local git_subrepos=`git subrepo status -q`
+        local subdircommand
+        subdircommand="$(__git_find_on_cmdline "$subdircommands")"
+        if [ -n "$subdircommand" ]; then
+            local git_subrepos
+            git_subrepos=$(git subrepo status -q)
             __gitcomp "$git_subrepos"
         fi
 

share/completion.bash

@@ -17,6 +17,7 @@ if [[ -n ${BASH_VERSION-} ]]; then
         {,/usr/local,~/.homebrew}/etc/bash_completion.d/git
       do
         # If a file is found at the location being checked…
+        # shellcheck source=/dev/null
         if [[ -f $f ]]; then
           # …source it.
           source "$f"
@@ -35,10 +36,14 @@ if [[ -n ${BASH_VERSION-} ]]; then
       # If no file was found at any of the potential file-paths checked
       # above, source a bundled copy of
       # <https://github.com/git/git/blob/c285171/contrib/completion/git-completion.bash>.
+
+      # shellcheck source=share/git-completion.bash
       source "$GIT_SUBREPO_ROOT/share/git-completion.bash"
     }
   fi
   # Load our Bash completion facilities.
+
+  # shellcheck source=share/completion.bash
   source "$GIT_SUBREPO_ROOT/share/completion.bash"
 elif [[ -n ${ZSH_VERSION-} ]]; then
   # Zsh

share/enable-completion.sh

@@ -17,6 +17,7 @@ BASHLIB=$(
 export BASHLIB
 
 export PATH=$BASHLIB:$PATH
+# shellcheck disable=SC1091
 source bash+ :std
 
 source 'lib/git-subrepo'