Merge pull request #14 from zstyblik/check_bash_shell

Add checkbashisms and shellcheck as part of CI

.github/workflows/ii_wrapper.yml

@@ -8,7 +8,18 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
+    - name: Git checkout
+      uses: actions/checkout@v4
+    - name: Install linters
+      uses: awalsh128/[email protected]
+      with:
+        packages: devscripts shellcheck
+    - name: Run checkbashisms
+      run: |
+        ./ci/run-checkbashisms.sh
+    - name: Run shellcheck
+      run: |
+        ./ci/run-shellcheck.sh
     - name: Set up Python 3.11
       uses: actions/setup-python@v5
       with:

ci/run-black.sh

@@ -5,19 +5,17 @@ set -u
 
 MODE=${1:?Mode must be given.}
 
-if [ "${MODE}" == "check" ]; then
+if [ "${MODE}" = "check" ]; then
     black_arg=" --check"
-elif [ "${MODE}" == "diff" ]; then
+elif [ "${MODE}" = "diff" ]; then
     black_arg=" --diff"
-elif [ "${MODE}" == "format" ]; then
+elif [ "${MODE}" = "format" ]; then
     black_arg=""
 else
     printf "Mode '%s' is not supported.\n" "${MODE}" 1>&2
     exit 1
 fi
 
-python3 \
-    -m black \
-    ${black_arg} \
-    -l 80 \
-    `find . ! -path '*/\.*' -name '*.py'`
+# shellcheck disable=SC2086
+find . ! -path '*/\.*' -name '*.py' -print0 | \
+    xargs -0 -- python3 -m black ${black_arg} -l 80

ci/run-checkbashisms.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -e
+set -u
+
+find . \( -name '*.sh' -or -name iibot-ng \) -print0 | \
+    xargs -0 -- checkbashisms --newline --force --lint --extra

ci/run-reorder-python-imports.sh

@@ -2,4 +2,5 @@
 set -e
 set -u
 
-reorder-python-imports `find . ! -path '*/\.*' -name '*.py'`
+find . ! -path '*/\.*' -name '*.py' -print0 | \
+    xargs -0 -- reorder-python-imports

ci/run-shellcheck.sh

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -e
+set -u
+
+find . \( -name '*.sh' -or -name iibot-ng \) -print0 | \
+    xargs -0 -- shellcheck

iibot-ng

@@ -16,6 +16,7 @@ set -u
 
 monitor()
 {
+    # shellcheck disable=SC3043
     local iipid="${1}"
     tail -f -n1 --pid="${iipid}" "${ircdir}/${network}/${channel}/out" | \
         # NOTE: format of output changed in v1.8
@@ -24,6 +25,8 @@ monitor()
             if [ "$nick" = '-!-' ]; then
                 continue
             fi
+            # shellcheck disable=SC2034
+            nixtime_is_unused="${nixtime}"
             # strip < and >. if msg is by ourself ignore it
             nick=$(printf -- "%s" "${nick}" | sed -e 's@^<@@' | sed -e 's@>$@@')
             if [ "${nick}" = "${nickname}" ]; then
@@ -62,6 +65,7 @@ monitor()
 
 monitor_link()
 {
+    # shellcheck disable=SC3043
     local iipid="${1}"
     IFS='
 '