Merge pull request #70 from bskinn/68-ci-format-check

Add formatting check to CI

.github/workflows/check_formatting.yml

@@ -0,0 +1,27 @@
+name: check-formatting
+
+on: push
+
+jobs:
+  format:
+    name: Check Code Autoformatting
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repo
+        uses: actions/checkout@v4
+
+      - name: Set up Node w/caching
+        uses: actions/setup-node@v4
+        with:
+          cache: 'npm'
+          cache-dependency-path: 'package-lock.json'
+
+      - name: Install deps
+        run: npm install
+
+      - name: Run formatting
+        run: npm run format
+
+      - name: Check for dirty working tree
+        run: scripts/check-dirty-tree.sh

CHANGELOG.md

@@ -16,6 +16,7 @@ serves to distinguish between multiple releases created on the same day.
 
 - Relocated dev helper scripts to `scripts/` folder.
 
+- Added CI workflow to check formatting, TOCs, Mermaid on pull
 
 ### Features at CHANGELOG Creation
 

scripts/check-dirty-tree.sh

@@ -0,0 +1,29 @@
+#! /bin/bash
+
+#####################################################################
+# Per https://sharats.me/posts/shell-script-best-practices/ (partial)
+# set -o errexit  # We don't want this because we're trapping errors
+set -o nounset
+set -o pipefail
+
+if [[ "${TRACE-0}" == "1" ]]; then
+    set -o xtrace
+fi
+#####################################################################
+
+git status | grep modified:
+
+RESULT=$?
+
+if [ $RESULT = 0 ]
+then
+  # grep found something modified, reject
+  exit 1
+elif [ $RESULT = 1 ]
+then
+  # grep didn't find anything, we're ok
+  exit 0
+else
+  # Some other error
+  exit $RESULT
+fi