bin: switch scripts to "stack ghc" and "env -S" (#1453)

Using stack's script command meant that the scripts needed to be
compatible, and regularly tested, with a hledger release in stackage,
rather than the latest hledger source. This created hassles for
maintainers, contributors and sometimes for users.

To simplify things overall, we now require script users to check out
the hledger source tree and run the scripts (or, bin/compile.sh) from
there once so they compile themselves. Some notes on alternative
setups are included (in one of the scripts, and referenced by the
others). This ensures that users and our CI tests are building scripts
the same way.

Current stack does not allow a stack options line to be used with the
"stack ghc" command, unfortunately, so instead we are using env's -S
flag, which hopefully has sufficiently wide support by now, and
putting all arguments in the shebang line.

This method will probably require complete explicit --package options,
unlike "stack script", so more testing and tweaking is expected.
Probably we're going to end up with some long shebang lines.

This isn't pretty but seems like a possible way to keep things
manageable.

bin/hledger-balance-as-budget.hs

@@ -1,5 +1,5 @@
-#!/usr/bin/env stack
--- stack script --compile --resolver lts-16.25
+#!/usr/bin/env -S stack ghc --verbosity info --package hledger -- -O0
+-- See hledger-check-fancyassertions.hs
 
 -- {-# OPTIONS_GHC -Wno-missing-signatures -Wno-name-shadowing #-}
 

bin/hledger-check-fancyassertions.hs

@@ -1,5 +1,24 @@
-#!/usr/bin/env stack
--- stack script --compile --resolver lts-16.25
+#!/usr/bin/env -S stack ghc --verbosity info --package hledger-lib -- -O0
+-- Run this script once from inside the hledger source tree; it will
+-- compile itself using the corresponding source version of hledger,
+-- which is the version it is tested with. You can run the compiled
+-- version from anywhere. It is compiled unoptimised, which takes less
+-- time and probably won't be noticeable otherwise; if you care, you
+-- can remove the "-O0" above.
+--
+-- To run it interpreted, eg while tweaking it: replace "ghc" above
+-- with "runghc", and run from inside the hledger source tree.
+--
+-- To make it a standalone script that runs from anywhere and
+-- recompiles itself when changed: replace "ghc" above with
+-- "script --compile --resolver lts-16" (eg).
+-- However this uses the hledger version from that stackage resolver,
+-- so in this case you should check out the corresponding release-tagged
+-- version of this script for compatibility (eg: git checkout 1.18.1).
+--
+-- env -S and a multi-argument shebang line is used, rather than a stack
+-- options line, because current stack won't run the ghc command that way.
+-- Hopefully your env supports -S.
 
 {-
 ```

bin/hledger-check-tagfiles.hs

@@ -1,5 +1,5 @@
-#!/usr/bin/env stack
--- stack script --compile --resolver lts-16.25
+#!/usr/bin/env -S stack ghc --verbosity info --package hledger -- -O0
+-- See hledger-check-fancyassertions.hs
 
 {-
 hledger-check-tagfiles stack script.

bin/hledger-combine-balances.hs

@@ -1,5 +1,5 @@
-#!/usr/bin/env stack
--- stack script --compile --resolver lts-16.25
+#!/usr/bin/env -S stack ghc --verbosity info --package hledger -- -O0
+-- See hledger-check-fancyassertions.hs
 
 {-# OPTIONS_GHC -Wno-missing-signatures -Wno-name-shadowing #-}
 

bin/hledger-print-location.hs

@@ -1,6 +1,8 @@
-#!/usr/bin/env stack
-{- stack script --compile --resolver lts-16.25
--}
+#!/usr/bin/env -S stack ghc --verbosity info --package hledger -- -O0
+-- See hledger-check-fancyassertions.hs
+
+--package string-qq
+
 {-
 Quick script that adds file/line number tags to print output.
 cf https://www.reddit.com/r/plaintextaccounting/comments/ddzn8o/finding_corresponding_journal_files_from_hledger/

bin/hledger-smooth.hs

@@ -1,5 +1,7 @@
-#!/usr/bin/env stack
--- stack script --compile --resolver lts-16.25
+#!/usr/bin/env -S stack ghc --verbosity info --package hledger -- -O0
+-- See hledger-check-fancyassertions.hs
+
+--package string-qq
 
 -- This is an unfinished prototype, see https://github.com/simonmichael/hledger/issues/1171
 -- Requires a contemporaneous version of the hledger package.

bin/hledger-swap-dates.hs

@@ -1,5 +1,5 @@
-#!/usr/bin/env stack
--- stack script --compile --resolver lts-16.25
+#!/usr/bin/env -S stack ghc --verbosity info --package hledger -- -O0
+-- See hledger-check-fancyassertions.hs
 
 {-# OPTIONS_GHC -Wno-missing-signatures -Wno-name-shadowing #-}
 {-# LANGUAGE NamedFieldPuns #-}

bin/scripts.test

@@ -3,10 +3,10 @@
 # Check that they all (or at least these ones) still compile with this version of hledger.
 # stdout and exit code are ignored for cleaner failure output.
 # $ ./compile.sh >/dev/null
-$  stack ghc -- hledger-balance-as-budget.hs     >/dev/null || true
-$  stack ghc -- hledger-check-fancyassertions.hs >/dev/null || true
-$  stack ghc -- hledger-check-tagfiles.hs        >/dev/null || true
-$  stack ghc -- hledger-combine-balances.hs      >/dev/null || true
-$  stack ghc --package string-qq -- hledger-print-location.hs >/dev/null || true
-$  stack ghc --package string-qq -- hledger-smooth.hs         >/dev/null || true
-$  stack ghc --package string-qq -- hledger-swap-dates.hs     >/dev/null || true
+$  ./hledger-balance-as-budget.hs     >/dev/null || true
+$  ./hledger-check-fancyassertions.hs >/dev/null || true
+$  ./hledger-check-tagfiles.hs        >/dev/null || true
+$  ./hledger-combine-balances.hs      >/dev/null || true
+$  ./hledger-print-location.hs        >/dev/null || true
+$  ./hledger-smooth.hs                >/dev/null || true
+$  ./hledger-swap-dates.hs            >/dev/null || true