diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml deleted file mode 100644 index 552eb45..0000000 --- a/.github/workflows/build.yaml +++ /dev/null @@ -1,40 +0,0 @@ -name: Build - -on: - pull_request: - paths: - - "src/**.hs" - - scrive-prelude.cabal - - .github/workflows/build.yaml - push: - branches: - - main - workflow_dispatch: - -jobs: - cabal-build: - runs-on: - - ubuntu-latest - strategy: - matrix: - ghc: - - 9.2.4 - steps: - - uses: actions/checkout@v3 - - uses: haskell/actions/setup@v2 - id: setup-haskell - with: - ghc-version: ${{ matrix.ghc }} - cabal-version: 3.8.1.0 - - name: Create freeze file - run: cabal freeze - - uses: actions/cache@v3 - with: - key: ${{ runner.os }}-ghc-${{ matrix.ghc }}-${{ hashFiles('cabal.project.freeze') }} - path: ${{ steps.setup-haskell.outputs.cabal-store }} - - name: Install dependencies - run: | - sudo apt-get update - sudo apt-get install -y libgmp-dev libpq-dev - - name: Run cabal build - ${{ matrix.ghc }} - run: cabal build diff --git a/.github/workflows/formatting.yaml b/.github/workflows/formatting.yaml deleted file mode 100644 index 6bce209..0000000 --- a/.github/workflows/formatting.yaml +++ /dev/null @@ -1,21 +0,0 @@ -name: Formatting - -on: - pull_request: - paths: - - "src/**.hs" - - scrive-prelude.cabal - - .github/workflows/build.yaml - push: - branches: - - main - -jobs: - fourmolu: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - uses: fourmolu/fourmolu-action@v5 - with: - pattern: | - src/**/*.hs diff --git a/.github/workflows/fourmolu.yaml b/.github/workflows/fourmolu.yaml new file mode 100644 index 0000000..4730c86 --- /dev/null +++ b/.github/workflows/fourmolu.yaml @@ -0,0 +1,10 @@ +name: Fourmolu +on: push +jobs: + format: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: haskell-actions/run-fourmolu@v10 + with: + version: "0.15.0.0" diff --git a/.github/workflows/haskell-ci.yml b/.github/workflows/haskell-ci.yml new file mode 100644 index 0000000..2f78b64 --- /dev/null +++ b/.github/workflows/haskell-ci.yml @@ -0,0 +1,222 @@ +# This GitHub workflow config has been generated by a script via +# +# haskell-ci 'github' '--config=cabal.haskell-ci' 'cabal.project' +# +# To regenerate the script (for example after adjusting tested-with) run +# +# haskell-ci regenerate +# +# For more information, see https://github.com/haskell-CI/haskell-ci +# +# version: 0.19.20240708 +# +# REGENDATA ("0.19.20240708",["github","--config=cabal.haskell-ci","cabal.project"]) +# +name: Haskell-CI +on: + push: + branches: + - master + pull_request: + branches: + - master +jobs: + linux: + name: Haskell-CI - Linux - ${{ matrix.compiler }} + runs-on: ubuntu-20.04 + timeout-minutes: + 60 + container: + image: buildpack-deps:jammy + continue-on-error: ${{ matrix.allow-failure }} + strategy: + matrix: + include: + - compiler: ghc-9.10.1 + compilerKind: ghc + compilerVersion: 9.10.1 + setup-method: ghcup + allow-failure: false + - compiler: ghc-9.8.2 + compilerKind: ghc + compilerVersion: 9.8.2 + setup-method: ghcup + allow-failure: false + - compiler: ghc-9.6.6 + compilerKind: ghc + compilerVersion: 9.6.6 + setup-method: ghcup + allow-failure: false + - compiler: ghc-9.4.8 + compilerKind: ghc + compilerVersion: 9.4.8 + setup-method: ghcup + allow-failure: false + - compiler: ghc-9.2.2 + compilerKind: ghc + compilerVersion: 9.2.2 + setup-method: ghcup + allow-failure: false + - compiler: ghc-9.0.2 + compilerKind: ghc + compilerVersion: 9.0.2 + setup-method: ghcup + allow-failure: false + - compiler: ghc-8.10.7 + compilerKind: ghc + compilerVersion: 8.10.7 + setup-method: ghcup + allow-failure: false + fail-fast: false + steps: + - name: apt + run: | + apt-get update + apt-get install -y --no-install-recommends gnupg ca-certificates dirmngr curl git software-properties-common libtinfo5 + mkdir -p "$HOME/.ghcup/bin" + curl -sL https://downloads.haskell.org/ghcup/0.1.30.0/x86_64-linux-ghcup-0.1.30.0 > "$HOME/.ghcup/bin/ghcup" + chmod a+x "$HOME/.ghcup/bin/ghcup" + "$HOME/.ghcup/bin/ghcup" install ghc "$HCVER" || (cat "$HOME"/.ghcup/logs/*.* && false) + "$HOME/.ghcup/bin/ghcup" install cabal 3.12.1.0 || (cat "$HOME"/.ghcup/logs/*.* && false) + env: + HCKIND: ${{ matrix.compilerKind }} + HCNAME: ${{ matrix.compiler }} + HCVER: ${{ matrix.compilerVersion }} + - name: Set PATH and environment variables + run: | + echo "$HOME/.cabal/bin" >> $GITHUB_PATH + echo "LANG=C.UTF-8" >> "$GITHUB_ENV" + echo "CABAL_DIR=$HOME/.cabal" >> "$GITHUB_ENV" + echo "CABAL_CONFIG=$HOME/.cabal/config" >> "$GITHUB_ENV" + HCDIR=/opt/$HCKIND/$HCVER + HC=$("$HOME/.ghcup/bin/ghcup" whereis ghc "$HCVER") + HCPKG=$(echo "$HC" | sed 's#ghc$#ghc-pkg#') + HADDOCK=$(echo "$HC" | sed 's#ghc$#haddock#') + echo "HC=$HC" >> "$GITHUB_ENV" + echo "HCPKG=$HCPKG" >> "$GITHUB_ENV" + echo "HADDOCK=$HADDOCK" >> "$GITHUB_ENV" + echo "CABAL=$HOME/.ghcup/bin/cabal-3.12.1.0 -vnormal+nowrap" >> "$GITHUB_ENV" + HCNUMVER=$(${HC} --numeric-version|perl -ne '/^(\d+)\.(\d+)\.(\d+)(\.(\d+))?$/; print(10000 * $1 + 100 * $2 + ($3 == 0 ? $5 != 1 : $3))') + echo "HCNUMVER=$HCNUMVER" >> "$GITHUB_ENV" + echo "ARG_TESTS=--enable-tests" >> "$GITHUB_ENV" + echo "ARG_BENCH=--enable-benchmarks" >> "$GITHUB_ENV" + echo "HEADHACKAGE=false" >> "$GITHUB_ENV" + echo "ARG_COMPILER=--$HCKIND --with-compiler=$HC" >> "$GITHUB_ENV" + echo "GHCJSARITH=0" >> "$GITHUB_ENV" + env: + HCKIND: ${{ matrix.compilerKind }} + HCNAME: ${{ matrix.compiler }} + HCVER: ${{ matrix.compilerVersion }} + - name: env + run: | + env + - name: write cabal config + run: | + mkdir -p $CABAL_DIR + cat >> $CABAL_CONFIG <> $CABAL_CONFIG < cabal-plan.xz + echo 'f62ccb2971567a5f638f2005ad3173dba14693a45154c1508645c52289714cb2 cabal-plan.xz' | sha256sum -c - + xz -d < cabal-plan.xz > $HOME/.cabal/bin/cabal-plan + rm -f cabal-plan.xz + chmod a+x $HOME/.cabal/bin/cabal-plan + cabal-plan --version + - name: checkout + uses: actions/checkout@v4 + with: + path: source + - name: initial cabal.project for sdist + run: | + touch cabal.project + echo "packages: $GITHUB_WORKSPACE/source/." >> cabal.project + cat cabal.project + - name: sdist + run: | + mkdir -p sdist + $CABAL sdist all --output-dir $GITHUB_WORKSPACE/sdist + - name: unpack + run: | + mkdir -p unpacked + find sdist -maxdepth 1 -type f -name '*.tar.gz' -exec tar -C $GITHUB_WORKSPACE/unpacked -xzvf {} \; + - name: generate cabal.project + run: | + PKGDIR_scrive_prelude="$(find "$GITHUB_WORKSPACE/unpacked" -maxdepth 1 -type d -regex '.*/scrive-prelude-[0-9.]*')" + echo "PKGDIR_scrive_prelude=${PKGDIR_scrive_prelude}" >> "$GITHUB_ENV" + rm -f cabal.project cabal.project.local + touch cabal.project + touch cabal.project.local + echo "packages: ${PKGDIR_scrive_prelude}" >> cabal.project + echo "package scrive-prelude" >> cabal.project + echo " ghc-options: -Werror=missing-methods" >> cabal.project + cat >> cabal.project <> cabal.project.local + cat cabal.project + cat cabal.project.local + - name: dump install plan + run: | + $CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH --dry-run all + cabal-plan + - name: restore cache + uses: actions/cache/restore@v4 + with: + key: ${{ runner.os }}-${{ matrix.compiler }}-${{ github.sha }} + path: ~/.cabal/store + restore-keys: ${{ runner.os }}-${{ matrix.compiler }}- + - name: install dependencies + run: | + $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks --dependencies-only -j2 all + $CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH --dependencies-only -j2 all + - name: build w/o tests + run: | + $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks all + - name: build + run: | + $CABAL v2-build $ARG_COMPILER $ARG_TESTS $ARG_BENCH all --write-ghc-environment-files=always + - name: cabal check + run: | + cd ${PKGDIR_scrive_prelude} || false + ${CABAL} -vnormal check + - name: haddock + run: | + $CABAL v2-haddock --disable-documentation --haddock-all $ARG_COMPILER --with-haddock $HADDOCK $ARG_TESTS $ARG_BENCH all + - name: unconstrained build + run: | + rm -f cabal.project.local + $CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks all + - name: save cache + uses: actions/cache/save@v4 + if: always() + with: + key: ${{ runner.os }}-${{ matrix.compiler }}-${{ github.sha }} + path: ~/.cabal/store diff --git a/cabal.haskell-ci b/cabal.haskell-ci new file mode 100644 index 0000000..9759054 --- /dev/null +++ b/cabal.haskell-ci @@ -0,0 +1,2 @@ +branches: master +tests: True diff --git a/cabal.project b/cabal.project new file mode 100644 index 0000000..e6fdbad --- /dev/null +++ b/cabal.project @@ -0,0 +1 @@ +packages: . diff --git a/fourmolu.yaml b/fourmolu.yaml index 8df5e08..ab91592 100644 --- a/fourmolu.yaml +++ b/fourmolu.yaml @@ -1,11 +1,56 @@ +# Number of spaces per indentation step indentation: 2 -function-arrows: leading # where to place arrows in type signatures -comma-style: leading # for lists, tuples etc. - can also be 'trailing' + +# Max line length for automatic line breaking +column-limit: none + +# Styling of arrows in type signatures (choices: trailing, leading, or leading-args) +function-arrows: leading + +# How to place commas in multi-line lists, records, etc. (choices: leading or trailing) +comma-style: leading + +# Styling of import/export lists (choices: leading, trailing, or diff-friendly) import-export-style: leading -indent-wheres: true # 'false' means save space by only half-indenting the 'where' keyword -record-brace-space: true # rec {x = 1} vs. rec{x = 1} -newlines-between-decls: 1 # number of newlines between top-level declarations -haddock-style: single-line # '--' vs. '{-' + +# Whether to full-indent or half-indent 'where' bindings past the preceding body +indent-wheres: true + +# Whether to leave a space before an opening record brace +record-brace-space: true + +# Number of spaces between top-level declarations +newlines-between-decls: 1 + +# How to print Haddock comments (choices: single-line, multi-line, or multi-line-compact) +haddock-style: single-line + +# How to print module docstring +haddock-style-module: null + +# Styling of let blocks (choices: auto, inline, newline, or mixed) let-style: inline -in-style: left-align -respectful: true # don't be too opinionated about newlines etc + +# How to align the 'in' keyword with respect to the 'let' keyword (choices: left-align, right-align, or no-space) +in-style: no-space + +# Whether to put parentheses around a single constraint (choices: auto, always, or never) +single-constraint-parens: never + +# Whether to put parentheses around a single deriving class (choices: auto, always, or never) +single-deriving-parens: always + +# Output Unicode syntax (choices: detect, always, or never) +unicode: never + +# Give the programmer more choice on where to insert blank lines +respectful: true + +# Fixity information for operators +fixities: [] + +# Module reexports Fourmolu should know about +reexports: +- module Prelude exports Data.Function +- module Prelude exports Control.Applicative +- module Prelude exports Control.Monad diff --git a/scrive-prelude.cabal b/scrive-prelude.cabal index 665fdb0..125d935 100644 --- a/scrive-prelude.cabal +++ b/scrive-prelude.cabal @@ -14,6 +14,8 @@ license: BSD-3-Clause license-file: LICENSE build-type: Simple +tested-with: GHC == { 8.10.7, 9.0.2, 9.2.2, 9.4.8, 9.6.6, 9.8.2, 9.10.1 } + common common-stanza default-language: Haskell2010 default-extensions: @@ -55,13 +57,17 @@ library import: common-stanza hs-source-dirs: src ghc-options: - -Werror -Wall -fno-warn-type-defaults -Wincomplete-record-updates - -Wredundant-constraints -Wunused-packages + -Wall -Wincomplete-record-updates -Wredundant-constraints -Wunused-packages + + if impl(ghc >= 9.8) + ghc-options: -Wno-x-partial + else + ghc-options: -Wno-dodgy-imports ghc-prof-options: -fprof-auto -fno-prof-count-entries -fprof-auto-calls exposed-modules: Prelude build-depends: - , base + , base <5 , cond , exceptions , extra diff --git a/src/Prelude.hs b/src/Prelude.hs index bd2ef76..657bd13 100644 --- a/src/Prelude.hs +++ b/src/Prelude.hs @@ -1,6 +1,6 @@ {-# LANGUAGE CPP #-} {-# LANGUAGE PackageImports #-} -{-# OPTIONS_GHC -fno-warn-orphans #-} +{-# OPTIONS_GHC -Wno-orphans #-} -- | Slightly customized replacement of Prelude. module Prelude @@ -46,6 +46,7 @@ module Prelude , maybeRead , minimum , read + , readEither , showt , showtp , tail @@ -67,7 +68,7 @@ import Data.Algebra.Boolean import Data.Either import qualified Data.Either.Optics as O import Data.Foldable (asum, foldMap, traverse_) -import Data.Functor +import Data.Functor hiding (unzip) import Data.List hiding ( all , and @@ -89,6 +90,7 @@ import qualified Data.Text as T import qualified Data.Text.Lazy as TL import qualified Data.Tuple.Optics as O import GHC.Generics (Generic) +import qualified GHC.Read as Read import GHC.Stack (HasCallStack, withFrozenCallStack) import Optics import qualified Optics as O @@ -142,6 +144,8 @@ import qualified Optics as O ) import Text.JSON.FromJSValue import Text.JSON.ToJSValue +import qualified Text.ParserCombinators.ReadP as Read +import qualified Text.ParserCombinators.ReadPrec as Read import Text.Pretty.Simple ( OutputOptions (..) , defaultOutputOptionsDarkBg @@ -204,9 +208,15 @@ for = flip map -- | Read a value and return 'Nothing' if an error occurs during parsing. maybeRead :: Read a => Text -> Maybe a -maybeRead s = case reads (T.unpack s) of - [(v, "")] -> Just v - _ -> Nothing +maybeRead s = + case [x | (x, "") <- Read.readPrec_to_S read' Read.minPrec $ T.unpack s] of + [x] -> Just x + _ -> Nothing + where + read' = do + x <- Read.readPrec + Read.lift Read.skipSpaces + pure x -- | Returns Just if the precondition is true. toMaybe :: Bool -> a -> Maybe a @@ -255,19 +265,24 @@ minimum = emptyList P.minimum $ emptyListError "minimum" -- | Replacement for 'P.read' that provides useful information on failure. read :: (HasCallStack, Read a, Show a) => Text -> a -read s = - let parsedS = reads $ T.unpack s - in fromMaybe - ( unexpectedError $ - "reading failed (input was '" - <> s - <> "', reads returned '" - <> showt parsedS - <> "')" - ) - $ do - [(v, "")] <- return parsedS - return v +read = either unexpectedError identity . readEither + +readEither :: (Read a, Show a) => Text -> Either Text a +readEither s = + case [x | (x, "") <- Read.readPrec_to_S read' Read.minPrec $ T.unpack s] of + [x] -> Right x + xs -> + Left $ + "reading failed (input was '" + <> s + <> "', reads returned '" + <> showt xs + <> "')" + where + read' = do + x <- Read.readPrec + Read.lift Read.skipSpaces + pure x -- | General version of 'fromJust' with a custom error message expectJust :: HasCallStack => Text -> Maybe a -> a