chordify · cdfa · Mar 17, 2017 · Mar 31, 2017 · Apr 2, 2017 · Apr 2, 2017
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -2,8 +2,9 @@ Before submitting your PR, check that you've:
 
 - [ ] Documented new APIs with [Haddock markup](https://www.haskell.org/haddock/doc/html/index.html)
 - [ ] Added [`@since` declarations](http://haskell-haddock.readthedocs.io/en/latest/markup.html#since) to the Haddock
-- [ ] Ran `stylish-haskell` on any changed files.
-- [ ] Adhered to the code style (see the `.editorconfig` file for details)
+- [ ] Ran `fourmolu` on any changed files (`restyled` will do this for you, so
+  accept the suggested changes if it makes them)
+- [ ] Adhered to the code style (see the `.editorconfig` and `fourmolu.yaml` files for details)
 
 After submitting your PR:
 

diff --git a/.github/workflows/haskell.yml b/.github/workflows/haskell.yml
@@ -45,21 +45,21 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        cabal: ["3.6"]
+        cabal: ["3.12"]
         ghc:
-          - "8.4.4"
-          - "8.6.5"
-          - "8.8.4"
-          - "8.10.7"
-          - "9.0.2"
-          - "9.2.4"
-          - "9.4.1"
+          - "9.0"
+          - "9.2"
+          - "9.4"
+          - "9.6"
+          - "9.8"
+          - "9.10"
+          - "9.12"
 
     env:
       CONFIG: "--enable-tests --enable-benchmarks"
     steps:
       - uses: actions/checkout@v2
-      - uses: haskell/actions/setup@v2
+      - uses: haskell-actions/setup@v2
         id: setup-haskell-cabal
         with:
           ghc-version: ${{ matrix.ghc }}
@@ -71,7 +71,8 @@ jobs:
         with:
           mongodb-version: '5.0'
       - name: Start Redis
-        uses: supercharge/redis-github-action@1.4.0
+        uses: shogo82148/actions-setup-redis@v1
+      - run: sudo apt-get update && sudo apt-get install -y libpcre3-dev
       - run: cabal v2-update
       - run: cabal v2-freeze $CONFIG
       - run: cat cabal.project.freeze
@@ -83,10 +84,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-${{ matrix.ghc }}-${{ hashFiles('cabal.project.freeze') }}
             ${{ runner.os }}-${{ matrix.ghc }}-
-      - run: cabal v2-build all --disable-optimization --only-dependencies $CONFIG
       - run: cabal v2-build all --disable-optimization $CONFIG
       - run: cabal v2-test all --disable-optimization $CONFIG --test-options "--fail-on-focus"
       - run: cabal v2-bench all --disable-optimization $CONFIG
-      - run: cabal v2-haddock all $CONFIG
-        continue-on-error: true
       - run: cabal v2-sdist all
diff --git a/.github/workflows/restyled.yml b/.github/workflows/restyled.yml
@@ -0,0 +1,20 @@
+# .github/workflows/restyled.yml
+
+name: Restyled
+
+on:
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  restyled:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: restyled-io/actions/setup@v4
+      - uses: restyled-io/actions/run@v4
+        with:
+          suggestions: true
diff --git a/.gitignore b/.gitignore
@@ -28,6 +28,14 @@ cabal.sandbox.config
 dist-newstyle/
 .ghc.environment.*
 
+# for direnv
+.envrc
+
+# nix relation
+.direnv/
+.env.local
+result/
+
 ## Docker image ignores
 /.cabal/
 /.stackage/

diff --git a/.restyled.yaml b/.restyled.yaml
@@ -0,0 +1,5 @@
+restylers:
+  - cabal-fmt
+  - fourmolu
+  - stylish-haskell:
+      enabled: false
diff --git a/.stylish-haskell.yaml b/.stylish-haskell.yaml
diff --git a/README.md b/README.md
@@ -1,6 +1,4 @@
-## Learn more: http://www.yesodweb.com/book/persistent
-
-[![Join the chat at https://gitter.im/yesodweb/persistent](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/yesodweb/persistent?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://travis-ci.org/yesodweb/persistent.svg?branch=master)](https://travis-ci.org/yesodweb/persistent) ![Hackage](https://img.shields.io/hackage/v/persistent.svg) ![Hackage-Deps](https://img.shields.io/hackage-deps/v/persistent.svg)
+# Persistent [![Build Status](https://travis-ci.org/yesodweb/persistent.svg?branch=master)](https://travis-ci.org/yesodweb/persistent) ![Hackage](https://img.shields.io/hackage/v/persistent.svg) ![Hackage-Deps](https://img.shields.io/hackage-deps/v/persistent.svg) [![Join the chat at https://gitter.im/yesodweb/persistent](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/yesodweb/persistent?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 A Haskell datastore. Datastores are often referred to as "ORM"s. While 'O' traditionally means object, the concept can be generalized as:
 
@@ -11,6 +9,69 @@ In dynamic languages rather than compile time errors, safety comes from creating
 
 Persistent's goal is to catch every possible error at compile-time, and it comes close to that.
 
+# Quickstart
+
+<details>
+<summary>
+Click to show package.yaml part.
+Learn more at <a href="https://www.yesodweb.com/book/persistent" target="_blank">http://www.yesodweb.com/book/persistent.</a>
+</summary>
+
+```yaml
+dependencies:
+- base ^>= 4.17
+- text ^>= 2
+- persistent ^>= 2.14
+- persistent-sqlite ^>= 2.13
+```
+
+</details>
+<p></p>
+
+```haskell
+{-# LANGUAGE EmptyDataDecls             #-}
+{-# LANGUAGE FlexibleContexts           #-}
+{-# LANGUAGE GADTs                      #-}
+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
+{-# LANGUAGE MultiParamTypeClasses      #-}
+{-# LANGUAGE OverloadedStrings          #-}
+{-# LANGUAGE QuasiQuotes                #-}
+{-# LANGUAGE TemplateHaskell            #-}
+{-# LANGUAGE TypeFamilies               #-}
+import           Control.Monad.IO.Class  (liftIO)
+import           Database.Persist
+import           Database.Persist.Sqlite
+import           Database.Persist.TH
+import           Data.Text
+
+share [mkPersist sqlSettings, mkMigrate "migrateAll"] [persistLowerCase|
+Person
+    name Text
+    age Int Maybe
+    deriving Show
+|]
+
+main :: IO ()
+main = runSqlite ":memory:" $ do
+    -- setup db schema
+    runMigration migrateAll
+
+    -- write to db
+    insert $ Person "Jane Doe" Nothing
+    johnId <- insert $ Person "John Doe" $ Just 35
+
+    -- read from db
+    john1 <- selectList [PersonId ==. johnId] [LimitTo 1]
+    john2 <- get johnId
+
+    liftIO $ print (john1 :: [Entity Person])
+    liftIO $ print (john2 :: Maybe Person)
+
+    -- delete from db
+    delete johnId
+    deleteWhere [PersonId ==. johnId]
+```
+
 # Backend agnostic
 
 Supports PostgreSql, Sqlite, MongoDB, Redis, ZooKeeper, and many other databases via [persistent-odbc](https://github.com/gbwey/persistent-odbc).
@@ -27,15 +88,12 @@ Key-value stores such as Redis can be used with persistent, but only fill out th
 Persistent provides several hooks to create backend-specific functionality.
 One can always fall back to using the raw database driver or other lower-level or less type-safe libraries and can utilize Persistent for un-serializing the database response to a Haskell record.
 
+# Help improve Persistent
 
-## Install from source
-
-Clone the repo and run `stack build` to build all targets. Persistent
+To install from source clone the repo and run `stack build` to build all targets. Persistent
 supports many backends. If you have only some of these installed the
 [development doc](development.md) shows how to build against a subset of
 targets.
 
-## Development
-
-For more information on how to hack ont he `persistent` set of libraries, see
+For more information on how to hack on the `persistent` set of libraries, see
 the [`development.md`](development.md) file.
diff --git a/cabal.project b/cabal.project
@@ -1,20 +1,35 @@
 packages:
-  persistent
-  persistent-sqlite
-  persistent-test
-  persistent-mongoDB
-  persistent-mysql
-  persistent-postgresql
-  persistent-redis
-  persistent-qq
+    persistent
+    persistent-sqlite
+    persistent-test
+    persistent-mongoDB
+    persistent-mysql
+    persistent-mysql-haskell
+    persistent-postgresql
+    persistent-redis
+    persistent-qq
 
--- GHC 9.4 shims for persistent
+-- required by nix but breaks macOS cabal builds:
+--package postgresql-libpq
+--    flags: +use-pkg-config
 
--- These need hackage revisions but otherwise test fine in the repo
 allow-newer:
-    -- https://github.com/haskellari/postgresql-simple/pull/95
-   , postgresql-simple:base
-   , postgresql-simple:template-haskell
+    -- https://github.com/fizruk/http-api-data/pull/146
+      http-api-data:base
+    , postgresql-simple:base
+    , postgresql-simple:template-haskell
+    , bytestring-lexing:base
+    , postgresql-simple-interval:persistent
+    , mysql-haskell:*
+
+allow-older:
+      mysql-haskell:deepseq
+
+source-repository-package
+    type: git
+    location: https://github.com/parsonsmatt/mysql
+    tag: 1e7dc274bf9a2919c9dd4298ed46c1bd1a1b677d
+    --sha256: 1zbwly28rpwkqqkj9cbsbr57rx2y79nbfcrvqmp7a0gxy0d9i4qy
 
 -- Needed to test that `persistent-redis` works with mtl-2.3
 -- https://github.com/informatikr/hedis/pull/190

diff --git a/development.md b/development.md
@@ -1,11 +1,10 @@
 # Style Guide
 
-## `stylish-haskell`
+## `fourmolu`
 
 This repository uses
-[`stylish-haskell`](https://hackage.haskell.org/package/stylish-haskell) as an
-autoformatter. `stylish-haskell` is inherently limited, so it won't handle
-everything, but it will format import lists, extension lists, etc.
+[`fourmolu`](https://hackage.haskell.org/package/fourmolu) as an
+autoformatter.
 
 ## `editorconfig`