entr.sh: Run hpack when important files change

* hooks.sh: Run hpack when important files change

* README.md: Recommend hooks.sh

* entr.sh: Call hooks.sh by default

* update.yml: Use stylish-haskell -r

* Remove obsolete scripts

Author: ttuegel

.github/workflows/update.yml

@@ -54,8 +54,7 @@ jobs:
           submodules: recursive
 
       - name: Format with stylish-haskell
-        run: |
-          find . -type f -name '*.hs*' '(' ! -path '*/.stack-work*' ')' '(' ! -path '*/dist*' ')' -print0 | xargs -0L1 stylish-haskell -i
+        run: stylish-haskell -i -r kore
 
       - name: Commit changes
         uses: stefanzweifel/[email protected]

README.md

@@ -64,6 +64,11 @@ For setting up a development environment, we recommend:
   compatible with most editors. See instructions
   [below](#running-a-language-server) to run a language server.
 - [hlint] and [stylish-haskell] for compliance with project guidelines.
+- [entr] and [fd] for running `./entr.sh` to keep important files up-to-date.
+
+We recommend to keep `./entr.sh` running in the background
+to keep important files (such as package descriptions) up-to-date,
+especially if the developer is using Cabal.
 
 ### Running a language server
 
@@ -117,3 +122,5 @@ This script is also run by an automatic workflow.
 [stylish-haskell]: https://github.com/jaspervdj/stylish-haskell
 [kore.cachix.org]: https://kore.cachix.org/
 [Nix]: https://nixos.org
+[entr]: https://github.com/eradman/entr
+[fd]: https://github.com/sharkdp/fd

entr.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+# entr.sh: Run a command when project files change.
+
+# Dependencies:
+#   entr: https://github.com/eradman/entr
+#   fd: https://github.com/sharkdp/fd
+
+last=2  # last exit code
+
+# entr runs the specified command whenever the listed files change,
+# and exits with code 2 when a file is added to any watched directory.
+# The loop restarts entr as long as it exits because of a new file.
+# If entr exits for any other reason, the loop is terminated.
+# This way, the script exits if the user interrupts it (for example).
+while test "$last" -eq 2
+do
+    fd '(package.yaml|.*.hs)' | entr -d -s "${@:-./hooks.sh}"
+    last=$?
+done

hooks.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+# hooks: run these commands when project files change
+
+hpack -f kore
+stylish-haskell -i -r kore

scripts/check.sh

@@ -6,8 +6,6 @@ export PATH="$HOME/.local/bin${PATH:+:}$PATH"
 
 export TOP=${TOP:-$(git rev-parse --show-toplevel)}
 
-source $TOP/scripts/run-on-haskell.include.sh
-
 if ! $TOP/scripts/git-assert-clean.sh
 then
     echo >&2 "Please commit your changes!"