Fixup packaging, stack-nightly, CI setup

* Configure fourmolu
* Re-organize package configuration
* Update GHA setup
* Behavior-neutral formatting changes
* hspec-core-2.10/11 compatibility

- The closed imports allow compatibility with <=2.9 and >2.10
- And a touch of CPP for a new constructor in 2.11

* Use hspec-golden

Author: pbrisbin

.github/workflows/ci.yml

@@ -12,40 +12,27 @@ jobs:
     strategy:
       matrix:
         stack-yaml:
-          - stack.yaml           # ghc-9.0
+          - stack-nightly.yaml   # ghc-9.6
+          - stack.yaml           # ghc-9.4
+          - stack-lts-20.26.yaml # ghc-9.2
+          - stack-lts-19.33.yaml # ghc-9.0
           - stack-lts-18.28.yaml # ghc-8.10
           - stack-lts-16.31.yaml # ghc-8.8
           - stack-lts-14.27.yaml # ghc-8.6
           - stack-lts-12.26.yaml # ghc-8.4
       fail-fast: false
 
     steps:
-      - uses: actions/checkout@v2
-      - uses: freckle/stack-cache-action@v2
+      - uses: actions/checkout@v4
+      - uses: freckle/stack-action@v4
         with:
           stack-yaml: ${{ matrix.stack-yaml }}
-      - uses: freckle/stack-action@v3
-        with:
-          stack-yaml: ${{ matrix.stack-yaml }}
-
-  nightly:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-      - uses: freckle/stack-cache-action@v2
-        with:
-          stack-yaml: stack-nightly.yaml
-      - uses: freckle/stack-action@v3
-        with:
-          stack-yaml: stack-nightly.yaml
-          stack-arguments: --resolver nightly
 
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: rwe/actions-hlint-setup@v1
-      - uses: rwe/actions-hlint-run@v2
+      - uses: actions/checkout@v4
+      - uses: haskell/actions/hlint-setup@v2
+      - uses: haskell/actions/hlint-run@v2
         with:
           fail-on: warning

.restyled.yaml

@@ -1,2 +1,7 @@
 exclude:
-  - "tests/golden.xml"
+  - "tests/golden/**/*.xml"
+
+restylers:
+  - fourmolu
+  - "!stylish-haskell"
+  - "*"

README.lhs

@@ -37,6 +37,21 @@ spec = describe "Addition" $ do
     2 + 2 `shouldBe` (4 :: Int)
 ```
 
+## Golden Testing
+
+This project's test suite uses [hspec-golden][] to generate an XML report for
+[`ExampleSpec.hs`](./tests/ExampleSpec.hs) and then compare that with golden XML
+files checked into the repository. If your work changes things in a
+functionally-correct way, but that diverges from the golden XML files, you need
+to regenerate them.
+
+1. Run `rm tests/golden*.xml`
+2. Run the specs again
+
+We maintain specific golden XML files for GHC 8.x vs 9.x, so you will need to
+re-run the test suite with at least one of each series to regenerate all the
+necessary files.
+
 ---
 
 [LICENSE](./LICENSE)

fourmolu.yaml

@@ -0,0 +1,15 @@
+indentation: 2
+column-limit: 80 # ignored until v12 / ghc-9.6
+function-arrows: leading
+comma-style: leading # default
+import-export-style: leading
+indent-wheres: false # default
+record-brace-space: true
+newlines-between-decls: 1 # default
+haddock-style: single-line
+let-style: mixed
+in-style: left-align
+single-constraint-parens: never # ignored until v12 / ghc-9.6
+unicode: never # default
+respectful: true # default
+fixities: [] # default

hspec-junit-formatter.cabal

@@ -1,10 +1,8 @@
-cabal-version: 1.12
+cabal-version: 1.18
 
 -- This file has been generated from package.yaml by hpack version 0.35.2.
 --
 -- see: https://github.com/sol/hpack
---
--- hash: 9b45343fdd935eeda31250fd2c6d69dfeb98841cb8ea89c23841ff7612e35b74
 
 name:           hspec-junit-formatter
 version:        1.1.0.2
@@ -20,12 +18,13 @@ license:        MIT
 license-file:   LICENSE
 build-type:     Simple
 extra-source-files:
+    tests/golden/default-ghc-8.xml
+    tests/golden/default-ghc-9.xml
+    tests/golden/prefixed-ghc-8.xml
+    tests/golden/prefixed-ghc-9.xml
+extra-doc-files:
     README.md
     CHANGELOG.md
-    tests/golden-ghc-9.xml
-    tests/golden-prefixed-ghc-9.xml
-    tests/golden-prefixed.xml
-    tests/golden.xml
 
 source-repository head
   type: git
@@ -67,6 +66,7 @@ library
       StandaloneDeriving
       TypeApplications
       TypeFamilies
+  ghc-options: -fignore-optim-changes -Weverything -Wno-all-missed-specialisations -Wno-missed-specialisations -Wno-missing-exported-signatures -Wno-missing-import-lists -Wno-missing-local-signatures -Wno-monomorphism-restriction -Wno-safe -Wno-unsafe
   build-depends:
       array
     , base <5
@@ -78,12 +78,18 @@ library
     , hspec-core >=2.8.1
     , iso8601-time
     , regex-base
-    , regex-tdfa >= 1.3.1
+    , regex-tdfa
     , text
     , time
     , xml-conduit
     , xml-types
   default-language: Haskell2010
+  if impl(ghc >= 9.2)
+    ghc-options: -Wno-missing-kind-signatures
+  if impl(ghc >= 8.10)
+    ghc-options: -Wno-missing-safe-haskell-mode -Wno-prepositive-qualified-module
+  if impl(ghc >= 8.8)
+    ghc-options: -fwrite-ide-info
 
 test-suite readme
   type: exitcode-stdio-1.0
@@ -114,13 +120,19 @@ test-suite readme
       StandaloneDeriving
       TypeApplications
       TypeFamilies
-  ghc-options: -pgmL markdown-unlit
+  ghc-options: -fignore-optim-changes -Weverything -Wno-all-missed-specialisations -Wno-missed-specialisations -Wno-missing-exported-signatures -Wno-missing-import-lists -Wno-missing-local-signatures -Wno-monomorphism-restriction -Wno-safe -Wno-unsafe -pgmL markdown-unlit
   build-depends:
       base <5
     , hspec
     , hspec-junit-formatter
     , markdown-unlit
   default-language: Haskell2010
+  if impl(ghc >= 9.2)
+    ghc-options: -Wno-missing-kind-signatures
+  if impl(ghc >= 8.10)
+    ghc-options: -Wno-missing-safe-haskell-mode -Wno-prepositive-qualified-module
+  if impl(ghc >= 8.8)
+    ghc-options: -fwrite-ide-info
 
 test-suite spec
   type: exitcode-stdio-1.0
@@ -154,14 +166,21 @@ test-suite spec
       StandaloneDeriving
       TypeApplications
       TypeFamilies
-  ghc-options: -threaded -rtsopts -O0 "-with-rtsopts=-N"
+  ghc-options: -fignore-optim-changes -Weverything -Wno-all-missed-specialisations -Wno-missed-specialisations -Wno-missing-exported-signatures -Wno-missing-import-lists -Wno-missing-local-signatures -Wno-monomorphism-restriction -Wno-safe -Wno-unsafe -threaded -rtsopts -O0 "-with-rtsopts=-N"
   build-depends:
       base <5
     , containers
     , filepath
     , hspec
+    , hspec-golden
     , hspec-junit-formatter
     , temporary
     , text
     , xml-conduit
   default-language: Haskell2010
+  if impl(ghc >= 9.2)
+    ghc-options: -Wno-missing-kind-signatures
+  if impl(ghc >= 8.10)
+    ghc-options: -Wno-missing-safe-haskell-mode -Wno-prepositive-qualified-module
+  if impl(ghc >= 8.8)
+    ghc-options: -fwrite-ide-info

library/Test/Hspec/Core/Runner/Ext.hs

@@ -5,15 +5,14 @@
 -- This feature is only available in hspec >= 2.9. Note that this module doesn't
 -- do anything to backport the feature; it just supplies a function that will
 -- use it when possible and safely no-op when not.
---
 module Test.Hspec.Core.Runner.Ext
   ( configAddAvailableFormatter
   ) where
 
 import Prelude
 
 import Test.Hspec.Core.Format (Format, FormatConfig)
-import Test.Hspec.Core.Runner (Config(..))
+import Test.Hspec.Core.Runner (Config (..))
 
 configAddAvailableFormatter
   :: String -> (FormatConfig -> IO Format) -> Config -> Config