Overhaul shell scripts (#144)

Resolves #143 (Overhaul shell scripts).

.github/workflows/ci.yml

@@ -33,4 +33,4 @@ jobs:
             - uses: actions/checkout@v4
             - name: Analyze
               shell: bash
-              run: ./ci/analyze --analyzer shellcheck
+              run: ./ci/analyze.sh --analyzer shellcheck

README.md

@@ -45,11 +45,11 @@ If the toolchain fails to locate tools, consult the documentation for CMake's
 
 ## Usage (Development)
 
-This repository's Git `pre-commit` hook script is the simplest way to configure, build,
+This repository's Git `pre-commit.sh` hook script is the simplest way to configure, build,
 and test this project during development.
-See the `pre-commit` script's help text for usage details.
+See the `pre-commit.sh` script's help text for usage details.
 ```shell
-./git/hooks/pre-commit --help
+./git/hooks/pre-commit.sh --help
 ```
 
 Additional checks, such as static analysis, are performed by this project's GitHub Actions
@@ -67,11 +67,11 @@ workflow.
 
 ## Git Hooks
 
-To install this repository's Git hooks, run the `install` script located in the
+To install this repository's Git hooks, run the `install.sh` script located in the
 `git/hooks` directory.
-See the `install` script's help text for usage details.
+See the `install.sh` script's help text for usage details.
 ```
-$ ./git/hooks/install --help
+$ ./git/hooks/install.sh --help
 ```
 
 ## Code of Conduct

ci/analyze → ci/analyze.sh

@@ -35,37 +35,75 @@ function abort()
     exit 1
 }
 
+function validate_script()
+{
+    if ! shellcheck "$script"; then
+        abort
+    fi
+}
+
 function display_help_text()
 {
-    echo "NAME"
-    echo "    $mnemonic - Run a static analyzer against toolchain-avr-gcc."
-    echo "SYNOPSIS"
-    echo "    $mnemonic --help"
-    echo "    $mnemonic --version"
-    echo "    $mnemonic --analyzer <analyzer>"
-    echo "OPTIONS"
-    echo "    --analyzer <analyzer>"
-    echo "        Specify the analyzer to run against toolchain-avr-gcc. The following"
-    echo "        analyzers are supported:"
-    echo "            shellcheck"
-    echo "    --help"
-    echo "        Display this help text."
-    echo "    --version"
-    echo "        Display the version of this script."
-    echo "EXAMPLES"
-    echo "    $mnemonic --help"
-    echo "    $mnemonic --version"
-    echo "    $mnemonic --analyzer shellcheck"
+    local analyzer
+
+    printf "%b" \
+        "NAME\n" \
+        "    $mnemonic - Ensure no static analysis errors are present.\n" \
+        "SYNOPSIS\n" \
+        "    $mnemonic --help\n" \
+        "    $mnemonic --version\n" \
+        "    $mnemonic --analyzer <analyzer>\n" \
+        "OPTIONS\n" \
+        "    --analyzer <analyzer>\n" \
+        "        Specify the analyzer to run. The following analyzers are supported:\n" \
+        ""
+
+    for analyzer in "${analyzers[@]}"; do
+        printf "%b" \
+            "            $analyzer\n" \
+            ""
+    done
+
+    printf "%b" \
+        "    --help\n" \
+        "        Display this help text.\n" \
+        "    --version\n" \
+        "        Display the version of this script.\n" \
+        "EXAMPLES\n" \
+        "    $mnemonic --help\n" \
+        "    $mnemonic --version\n" \
+        ""
+
+    for analyzer in "${analyzers[@]}"; do
+        printf "%b" \
+            "    $mnemonic --analyzer $analyzer\n" \
+            ""
+    done
 }
 
 function display_version()
 {
     echo "$mnemonic, version $version"
 }
 
+function value_is_in_array()
+{
+    local -r target_value="$1"; shift
+    local -r array=( "$@" )
+
+    local value
+    for value in "${array[@]}"; do
+        if [[ "$target_value" == "$value" ]]; then
+            return 0;
+        fi
+    done
+
+    return 1
+}
+
 function run_shellcheck()
 {
-    local scripts; mapfile -t scripts < <( git -C "$repository" ls-files ':!:*.py' | xargs -r -d '\n' -I '{}' find "$repository/{}" -executable ); readonly scripts
+    local scripts; mapfile -t scripts < <( git -C "$repository" ls-files '*.sh' | xargs -r -d '\n' -I '{}' find "$repository/{}" ); readonly scripts
 
     if ! shellcheck "${scripts[@]}"; then
         abort
@@ -81,9 +119,16 @@ function main()
 {
     local -r script=$( readlink -f "$0" )
     local -r mnemonic=$( basename "$script" )
+
+    validate_script
+
     local -r repository=$( readlink -f "$( dirname "$script" )/.." )
     local -r version=$( git -C "$repository" describe --match=none --always --dirty --broken )
 
+    local -r analyzers=(
+        shellcheck
+    )
+
     while [[ "$#" -gt 0 ]]; do
         local argument="$1"; shift
 
@@ -99,7 +144,7 @@ function main()
 
                 local -r analyzer="$1"; shift
 
-                if [[ "$analyzer" != "shellcheck" ]]; then
+                if ! value_is_in_array "$analyzer" "${analyzers[@]}"; then
                     abort "'$analyzer' is not a supported analyzer"
                 fi
                 ;;