Simplify pre-commit scripts. Caveats may apply.

Author: wenkokke

.github/workflows/haskell.yml

@@ -169,11 +169,6 @@ jobs:
     - name: Checkout repository
       uses: actions/checkout@v4
 
-    - name: Install system dependencies (apt-get)
-      run: |
-        sudo apt-get update || true
-        sudo apt-get -y install fd-find
-
     - name: Setup Haskell
       id: setup-haskell
       uses: haskell-actions/setup@v2
@@ -210,7 +205,7 @@ jobs:
 
     - name: Run stylish-haskell
       run: |
-        ./scripts/format-stylish-fd.sh
+        ./scripts/format-stylish.sh
         git diff --exit-code
 
   # Check formatting for cabal files
@@ -233,11 +228,6 @@ jobs:
     - name: Checkout repository
       uses: actions/checkout@v4
 
-    - name: Install system dependencies (apt-get)
-      run: |
-        sudo apt-get update || true
-        sudo apt-get -y install fd-find
-
     - name: Setup Haskell
       id: setup-haskell
       uses: haskell-actions/setup@v2
@@ -274,7 +264,7 @@ jobs:
 
     - name: Run cabal-fmt
       run: |
-        ./scripts/format-cabal-fd.sh
+        ./scripts/format-cabal.sh
         git diff --exit-code
 
   # Check cabal files

scripts/check-cabal.sh

@@ -1,14 +1,15 @@
-#!/usr/bin/env bash
+#!/bin/sh
 
-set -euo pipefail
+# Check for cabal
+cabal="$(which cabal)"
+if [ "${cabal}" = "" ]; then
+    echo "Requires cabal; no version found"
+    exit 1
+fi
 
-for x in $(find . -name '*.cabal' | grep -v dist-newstyle | cut -c 3-); do
-  (
-    d=$(dirname $x)
-    if [ $(basename $d) != "bloomfilter" ]; then
-      echo "== $d =="
-      cd $d
-      cabal check
-    fi
-  )
-done
+# Check Cabal files with cabal
+echo "Checking Cabal source files with cabal"
+# shellcheck disable=SC2016
+if ! git ls-files --exclude-standard --no-deleted --deduplicate '*.cabal' | xargs -L 1 sh -c 'echo "$0" && cd "$(dirname "$0")" && cabal check'; then
+    exit 1
+fi

scripts/format-cabal-fd.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+
+export LC_ALL=C.UTF-8
+
+# Check for cabal-fmt
+cabal_fmt_required_version="0.1.12"
+cabal_fmt="$(which cabal-fmt)"
+if [ "${cabal_fmt}" = "" ]; then
+    echo "Requires cabal-fmt version ${cabal_fmt_required_version}; no version found"
+    exit 1
+fi
+cabal_fmt_installed_version="$($cabal_fmt --version | head -n 1 | cut -d' ' -f2)"
+if [ ! "${cabal_fmt_installed_version}" = "${cabal_fmt_required_version}" ]; then
+    echo "Requires cabal-fmt version ${cabal_fmt_required_version}; found version ${cabal_fmt_installed_version}"
+    exit 1
+fi
+
+# Check Cabal files with cabal-fmt
+echo "Formatting Cabal source files with cabal-fmt version ${cabal_fmt_required_version}"
+# shellcheck disable=SC2016
+if ! git ls-files --exclude-standard --no-deleted --deduplicate '*.cabal' | xargs -L 1 sh -c 'echo "$0" && cabal-fmt -i "$0"'; then
+    exit 1
+fi

scripts/format-cabal-find.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+
+export LC_ALL=C.UTF-8
+
+# Check for stylish-haskell
+stylish_haskell_required_version="0.14.6.0"
+stylish_haskell="$(which stylish-haskell)"
+if [ "${stylish_haskell}" = "" ]; then
+    echo "Requires stylish-haskell version ${stylish_haskell_required_version}; no version found"
+    exit 1
+fi
+stylish_haskell_installed_version="$($stylish_haskell --version | head -n 1 | cut -d' ' -f2)"
+if [ ! "${stylish_haskell_installed_version}" = "${stylish_haskell_required_version}" ]; then
+    echo "Requires stylish-haskell version ${stylish_haskell_required_version}; found version ${stylish_haskell_installed_version}"
+    exit 1
+fi
+
+# Check Haskell files with stylish-haskell
+echo "Formatting Haskell source files with stylish-haskell version ${stylish_haskell_required_version}"
+# shellcheck disable=SC2016
+if ! git ls-files --exclude-standard --no-deleted --deduplicate '*.hs' | xargs -L 1 sh -c 'echo "$0" && stylish-haskell -i -c .stylish-haskell.yaml "$0"'; then
+    exit 1
+fi

scripts/format-cabal.sh

@@ -0,0 +1,27 @@
+#!/bin/sh
+
+# To install as a Git pre-commit hook, run:
+#
+# > ln scripts/pre-commit.sh .git/hooks/pre-commit.sh
+#
+
+# Check for unstaged changes in Haskell files
+unstaged_haskell_files="$(git ls-files --exclude-standard --no-deleted --deduplicate --modified '*.hs')"
+if [ ! "${unstaged_haskell_files}" = "" ]; then
+    echo "Found unstaged Haskell files"
+    echo "${unstaged_haskell_files}"
+    exit 1
+fi
+
+# Check for unstaged changes in Cabal files
+unstaged_cabal_files="$(git ls-files --exclude-standard --no-deleted --deduplicate --modified '*.cabal')"
+if [ ! "${unstaged_cabal_files}" = "" ]; then
+    echo "Found unstaged Cabal files"
+    echo "${unstaged_cabal_files}"
+    exit 1
+fi
+
+# Run various checks and formatters
+./scripts/check-cabal.sh
+./scripts/format-cabal.sh
+./scripts/format-stylish.sh