ci(shfmt): add shfmt code formatting checks (#254)

Author: tiborsimko

.editorconfig

@@ -0,0 +1,17 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace=true
+
+[*.{css,html,js,json,scss,yaml,yml}]
+indent_size = 2
+
+[*.{py,sh}]
+indent_size = 4
+
+[*.go]
+indent_style = tab

.github/workflows/ci.yml

@@ -51,6 +51,17 @@ jobs:
           pip install black
           ./run-tests.sh --format-black
 
+  format-shfmt:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Check shell script code formatting
+        run: |
+          sudo apt-get install shfmt
+          ./run-tests.sh --format-shfmt
+
   lint-commitlint:
     runs-on: ubuntu-24.04
     steps:

MANIFEST.in

@@ -9,6 +9,7 @@ include *.md
 include *.sh
 include *.yaml
 include .dockerignore
+include .editorconfig
 include .flake8
 include LICENSE
 include pytest.ini

run-tests.sh

@@ -55,6 +55,10 @@ format_black() {
     black --check .
 }
 
+format_shfmt() {
+    shfmt -d .
+}
+
 lint_commitlint() {
     from=${2:-master}
     to=${3:-HEAD}
@@ -128,6 +132,7 @@ python_tests() {
 all() {
     docs_sphinx
     format_black
+    format_shfmt
     lint_commitlint
     lint_flake8
     lint_jsonlint
@@ -144,6 +149,7 @@ help() {
     echo "  --all                Perform all checks [default]"
     echo "  --docs-sphinx        Check Sphinx docs build"
     echo "  --format-black       Check formatting of Python code"
+    echo "  --format-shfmt       Check formatting of shell scripts"
     echo "  --help               Display this help message"
     echo "  --lint-commitlint    Check linting of commit messages"
     echo "  --lint-flake8        Check linting of Python code"
@@ -166,6 +172,7 @@ case $arg in
 --help) help ;;
 --docs-sphinx) docs_sphinx ;;
 --format-black) format_black ;;
+--format-shfmt) format_shfmt ;;
 --lint-commitlint) lint_commitlint "$@" ;;
 --lint-flake8) lint_flake8 ;;
 --lint-jsonlint) lint_jsonlint ;;