qa: Enforce JSON linter for GCT configs

.github/workflows/configs-json-lint.yml

@@ -0,0 +1,26 @@
+name: configs-json-lint
+on: [push, pull_request]
+
+jobs:
+  lint:
+    name: configs JSON lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Check configs JSON format
+        run: |
+          files=("config_example.json" "testdata/configtest.json")
+          for file in "${files[@]}"; do
+            processed_file="${file%.*}_processed.${file##*.}"
+            jq '.exchanges |= sort_by(.name)' --indent 1 $file > $processed_file
+            if ! diff $file $processed_file; then
+              echo "jq differences found in $file! Please run 'make lint_configs'"
+              exit 1
+            else
+              rm $processed_file
+              echo "No differences found in $file 🌞"
+            fi
+          done
+
+

Makefile

@@ -8,7 +8,7 @@ DRIVER ?= psql
 RACE_FLAG := $(if $(NO_RACE_TEST),,-race)
 CONFIG_FLAG = $(if $(CONFIG),-config $(CONFIG),)
 
-.PHONY: get linter check test build install update_deps
+.PHONY: get linter check test build install update_deps lint_configs
 
 all: check build
 
@@ -61,3 +61,19 @@ endif
 target/sqlboiler.json:
 	mkdir -p $(@D)
 	go run ./cmd/gen_sqlboiler_config/main.go $(CONFIG_FLAG) -outdir $(@D)
+
+.PHONY: lint_configs
+lint_configs: check-jq
+	@$(call sort-json,config_example.json)
+	@$(call sort-json,testdata/configtest.json)
+
+define sort-json
+	@echo "Processing $(1)..."
+	@jq '.exchanges |= sort_by(.name)' --indent 1 $(1) > $(1).temp && \
+		(mv $(1).temp $(1)) || \
+		(rm $(1).temp; echo "jq processing failed on $(1)"; exit 1)
+endef
+
+check-jq:
+	@echo "Checking if jq is installed..."
+	@command -v jq >/dev/null 2>&1 || { echo >&2 "jq is not installed. Please install jq to proceed."; exit 1; }