Add PrettyPrinter That Returns Both Errors & Text

Add a new `pPrintText` function to the Brittany.Main module that behaves similarly to the `coreIO` function, but instead only take a config & input string & always returns a list of errors & either the unaltered or the pretty printed text. This new function will always check the generated text & ignores all tracing and printing to stdout. This a useful function for utility programs, like haskell-language-server, that want to feed text to brittany & manipulate the output.
2021-07-09 20:06:02 -04:00
628 changed files with 14104 additions and 10537 deletions
--- a/.devcontainer/Dockerfile
+++ b/.devcontainer/Dockerfile
@ -1,30 +0,0 @@
-ARG UBUNTU_TAG=20.04
-FROM ubuntu:"$UBUNTU_TAG"
-
-ENV LANG=C.UTF-8
-RUN \
-    apt-get update && \
-    apt-get install --assume-yes curl gcc git libgmp-dev libtinfo-dev make sudo
-
-ARG GHCUP_VERSION=0.1.17.4
-RUN \
-    curl --output /usr/local/bin/ghcup "https://downloads.haskell.org/~ghcup/$GHCUP_VERSION/x86_64-linux-ghcup-$GHCUP_VERSION" && \
-    chmod +x /usr/local/bin/ghcup && \
-    ghcup --version
-
-ARG USER_NAME=haskell
-RUN \
-    useradd --create-home --shell "$( which bash )" "$USER_NAME" && \
-    echo "$USER_NAME ALL=(ALL) NOPASSWD: ALL" | tee "/etc/sudoers.d/$USER_NAME"
-USER "$USER_NAME"
-ENV PATH="/home/$USER_NAME/.cabal/bin:/home/$USER_NAME/.ghcup/bin:$PATH"
-
-ARG GHC_VERSION=9.0.1
-RUN \
-    ghcup install ghc "$GHC_VERSION" --set && \
-    ghc --version
-
-ARG CABAL_VERSION=3.6.2.0
-RUN \
-    ghcup install cabal "$CABAL_VERSION" --set && \
-    cabal --version
--- a/.devcontainer/devcontainer.json
+++ b/.devcontainer/devcontainer.json
@ -1,6 +0,0 @@
-{
-    "build": {
-        "dockerfile": "Dockerfile"
-    },
-    "postCreateCommand": "cabal update"
-}
--- a/.github/workflows/ci.yaml
+++ b/.github/workflows/ci.yaml
@ -2,35 +2,38 @@ name: CI
 on:
  pull_request:
    branches:
-      - main
      - master
  push:
    branches:
-      - main
      - master
-  release:
-    types:
-      - created
 jobs:
  build:
    strategy:
      fail-fast: false
      matrix:
+        os:
+          - macos-10.15
+          - ubuntu-18.04
+          - windows-2019
+        ghc:
+          - 8.10.2
+        cabal:
+          - 3.2.0.0
        include:
-          - { os: macos-11, ghc: 9.0.1, cabal: 3.6.2.0 }
-          - { os: ubuntu-20.04, ghc: 9.0.1, cabal: 3.6.2.0 }
-          - { os: windows-2019, ghc: 9.0.1, cabal: 3.6.2.0, ext: .exe }
+          - os: ubuntu-18.04
+            ghc: 8.8.4
+            cabal: 3.2.0.0
+          - os: ubuntu-18.04
+            ghc: 8.6.5
+            cabal: 3.2.0.0
    runs-on: ${{ matrix.os }}
    steps:
      - uses: actions/checkout@v2
-      - run: mkdir artifact
-      - run: mkdir artifact/${{ matrix.os }}
      - id: setup-haskell
-        uses: haskell/actions/setup@v1
+        uses: actions/setup-haskell@v1
        with:
          ghc-version: ${{ matrix.ghc }}
          cabal-version: ${{ matrix.cabal }}
-      - run: cabal configure --enable-tests --flags pedantic --jobs
      - run: cabal freeze
      - run: cat cabal.project.freeze
      - uses: actions/cache@v2
@ -40,66 +43,24 @@ jobs:
          restore-keys: |
            ${{ matrix.os }}-${{ matrix.ghc }}-${{ matrix.cabal }}-
            ${{ matrix.os }}-${{ matrix.ghc }}-
-      - run: cabal build
-      - run: cabal install --installdir artifact/${{ matrix.os }} --install-method copy
      - run: cabal test --test-show-details direct
-      - run: cabal check
-      - run: cabal sdist --output-dir artifact/${{ matrix.os }}
-      - uses: svenstaro/upx-action@v2
-        with:
-          file: artifact/${{ matrix.os }}/brittany${{ matrix.ext }}
+      - run: cabal install --installdir output --install-method copy
+      - run: strip output/brittany*
      - uses: actions/upload-artifact@v2
        with:
-          path: artifact
-          name: brittany-${{ github.sha }}
+          path: output/brittany*
+          name: brittany-${{ matrix.os }}-ghc-${{ matrix.ghc }}-${{ github.sha }}
+      - if: matrix.os == 'ubuntu-18.04' && matrix.ghc == '8.10.2'
+        uses: actions/upload-artifact@v2
+        with:
+          path: dist-newstyle/sdist/brittany-*.tar.gz
+          name: brittany-${{ github.sha }}.tar.gz
+      - run: cabal check

-  release:
-    needs: build
-    if: github.event_name == 'release'
-    runs-on: ubuntu-20.04
+
+  nix:
+    runs-on: ubuntu-latest
    steps:
-
+      - uses: cachix/install-nix-action@v12
      - uses: actions/checkout@v2
-
-      - uses: actions/download-artifact@v2
-        with:
-          name: brittany-${{ github.sha }}
-          path: artifact
-
-      - uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          asset_content_type: application/octet-stream
-          asset_name: brittany-${{ github.event.release.tag_name }}-ubuntu
-          asset_path: artifact/ubuntu-20.04/brittany
-          upload_url: ${{ github.event.release.upload_url }}
-
-      - uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          asset_content_type: application/octet-stream
-          asset_name: brittany-${{ github.event.release.tag_name }}-macos
-          asset_path: artifact/macos-11/brittany
-          upload_url: ${{ github.event.release.upload_url }}
-
-      - uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          asset_content_type: application/octet-stream
-          asset_name: brittany-${{ github.event.release.tag_name }}-windows.exe
-          asset_path: artifact/windows-2019/brittany.exe
-          upload_url: ${{ github.event.release.upload_url }}
-
-      - uses: actions/upload-release-asset@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          asset_content_type: application/gzip
-          asset_name: brittany-${{ github.event.release.tag_name }}.tar.gz
-          asset_path: artifact/ubuntu-20.04/brittany-${{ github.event.release.tag_name }}.tar.gz
-          upload_url: ${{ github.event.release.upload_url }}
-
-      - run: cabal upload --publish --username '${{ secrets.HACKAGE_USERNAME }}' --password '${{ secrets.HACKAGE_PASSWORD }}' artifact/ubuntu-20.04/brittany-${{ github.event.release.tag_name }}.tar.gz
+      - run: nix-build
--- a/.gitignore
+++ b/.gitignore
@ -8,8 +8,9 @@ dist/
 dist-newstyle/
 local/
 .cabal-sandbox/
+.stack-work/
 cabal.sandbox.config
-cabal.project.local*
-cabal.project.freeze
+cabal.project.local
 .ghc.environment.*
 result
+.stack-work*
--- a/.hlint.yaml
+++ b/.hlint.yaml
@ -5,12 +5,20 @@
 # This file contains a template configuration file, which is typically
 # placed as .hlint.yaml in the root of your project

- ignore: { name: 'Use :' }
- ignore: { name: Eta reduce }
- ignore: { name: Move brackets to avoid $ }
- ignore: { name: Redundant $ }
- ignore: { name: Redundant bracket }
- ignore: { name: Use newtype instead of data }
+# Specify additional command line arguments
+
+- arguments:
+    [ "--cpp-include=srcinc"
+    , "--language=GADTs"
+    , "--language=LambdaCase"
+    , "--language=MultiWayIf"
+    , "--language=KindSignatures"
+    , "--cross"
+    , "--threads=0"
+    ]
+
+- ignore: {name: "Use camelCase"}
+- ignore: {name: "Redundant as"}
 - ignore: {name: "Redundant do"}
 - ignore: {name: "Redundant return"}
- ignore: {name: "Use camelCase"}
+- ignore: {name: "Redundant guard", whithin: "lrdrNameToTextAnn"}
--- a/.travis.yml
+++ b/.travis.yml
@ -0,0 +1 @@
+language: minimal
--- a/.vscode/extensions.json
+++ b/.vscode/extensions.json
@ -1,5 +0,0 @@
-{
-    "recommendations": [
-        "taylorfausak.purple-yolk"
-    ]
-}
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@ -1,6 +0,0 @@
-{
-    "purple-yolk.brittany.command": "cabal exec -- brittany --write-mode inplace",
-    "purple-yolk.ghci.command": "cabal repl --repl-options -ddump-json",
-    "purple-yolk.hlint.command": "false",
-    "purple-yolk.hlint.onSave": false
-}
--- a/ChangeLog.md
+++ b/ChangeLog.md
@ -1,12 +1,5 @@
 # Revision history for brittany

-## 0.14.0.0 -- November 2021
-
-* #357: Added support for GHC 9.0. Dropped support for all other versions of GHC.
-  * ab59e9acc3069551ac4132321b285d000f5f5691: Removed runtime dependency on `ghc-paths`.
-  * fa8365a7fa9372043d5a1018f2f7669ce3853edd: Started providing pre-built binaries for Linux, MacOS, and Windows.
-  * Many other changes to Brittany's internals and exposed Haskell interface, but (hopefully) no changes to its command-line interface.
-
 ## 0.13.1.2 -- May 2021

 * #347: Allowed hspec 2.8. Thanks @felixonmars!
--- a/18
+++ b/18
@ -0,0 +1,18 @@
+.PHONY: test
+test:
+	echo "test"
+	stack test
+
+.PHONY: test-all
+test-all:
+	$(MAKE) test test-8.8.4 test-8.6.5
+
+.PHONY: test-8.8.4
+test-8.8.4:
+	echo "test 8.8.4"
+	stack test --stack-yaml stack-8.8.4.yaml --work-dir .stack-work-8.8.4
+
+.PHONY: test-8.6.5
+test-8.6.5:
+	echo "test 8.6.5"
+	stack test --stack-yaml stack-8.6.5.yaml --work-dir .stack-work-8.6.5
--- a/README.md
+++ b/README.md
@ -1,11 +1,4 @@
 # brittany [![Hackage version](https://img.shields.io/hackage/v/brittany.svg?label=Hackage)](https://hackage.haskell.org/package/brittany) [![Stackage version](https://www.stackage.org/package/brittany/badge/lts?label=Stackage)](https://www.stackage.org/package/brittany) [![Build Status](https://secure.travis-ci.org/lspitzner/brittany.svg?branch=master)](http://travis-ci.org/lspitzner/brittany)
-
-:warning:
-This project is effectively unmaintained!
-I ([@tfausak](https://github.com/tfausak)) would recommend switching to another formatter.
-At time of writing (2022-11-11), I would suggest [Ormolu](https://github.com/tweag/ormolu).
-Or if you prefer some configuration, I would suggest [Fourmolu](https://github.com/fourmolu/fourmolu).
-
 haskell source code formatter

 ![Output sample](https://github.com/lspitzner/brittany/raw/master/brittany-sample.gif)
@ -55,7 +48,7 @@ log the size of the input, but _not_ the full input/output of requests.)

 # Other usage notes

- Supports GHC version `9.0.x`.
+- Supports GHC versions `8.6`, `8.8`, `8.10`.
 - included in stackage with lts>=10.0 (or nightlies dating to >=2017-11-15)
 - config (file) documentation is lacking.
 - some config values can not be configured via commandline yet.
@ -68,11 +61,18 @@ log the size of the input, but _not_ the full input/output of requests.)
 - via `stack`

    ~~~~.sh
-    stack install brittany # --resolver lts-16.31
+    stack install brittany # --resolver lts-10.0
    ~~~~

    If you use an lts that includes brittany this should just work; otherwise
-    you may want to clone the repo and try again.
+    you may want to clone the repo and try again (there are several stack.yamls
+    included).
+
+- via `nix`:
+    ~~~.sh
+    nix build
+    nix-env -i ./result
+    ~~~

 - via `cabal`

@ -103,6 +103,18 @@ log the size of the input, but _not_ the full input/output of requests.)

 # Development tips

+## Run a hoogle server
+
+To host a local Hoogle server with all of Brittany's dependencies run:
+
+```sh
+echo brittany.cabal |
+  $(nix-build '<nixpkgs>' --no-link -A entr)/bin/entr -r -- \
+    sh -c "nix-shell --run 'hoogle server --local'"
+```
+
+This will watch `brittany.cabal` for changes and restart the server when new dependencies are added there.
+
 # Editor Integration

 #### Sublime text
@ -111,8 +123,8 @@ log the size of the input, but _not_ the full input/output of requests.)
 #### VSCode
  [This extension](https://marketplace.visualstudio.com/items?itemName=MaxGabriel.brittany)
  connects commandline `brittany` to VSCode formatting API. Thanks to @MaxGabriel.
-#### Via HLS
-  [haskell-language-server](https://github.com/haskell/haskell-language-server)
+#### Via HIE
+  [haskell-ide-engine](https://github.com/haskell/haskell-ide-engine)
  includes a `brittany` plugin that directly uses the brittany library.
  Relevant for any editors that properly support the language-server-protocol.
 #### Neovim / Vim 8
--- a/Setup.hs
+++ b/Setup.hs
@ -0,0 +1,2 @@
+import Distribution.Simple
+main = defaultMain
--- a/brittany.cabal
+++ b/brittany.cabal
@ -1,15 +1,14 @@
-cabal-version: 2.2
-
 name:                 brittany
-version:              0.14.0.2
+version:              0.13.1.2
 synopsis:             Haskell source code formatter
-description:
+description: {
  See <https://github.com/lspitzner/brittany/blob/master/README.md the README>.
  .
  If you are interested in the implementation, have a look at <https://github.com/lspitzner/brittany/blob/master/doc/implementation/theory.md this document>;
  .
  The implementation is documented in more detail <https://github.com/lspitzner/brittany/blob/master/doc/implementation/index.md here>.
-license:              AGPL-3.0-only
+}
+license:              AGPL-3
 license-file:         LICENSE
 author:               Lennart Spitzner
 maintainer:           Lennart Spitzner <hexagoxel@hexagoxel.de>
@ -17,133 +16,326 @@ copyright:            Copyright (C) 2016-2019 Lennart Spitzner
                      Copyright (C) 2019 PRODA LTD
 category:             Language
 build-type:           Simple
+cabal-version:        1.18
 homepage:             https://github.com/lspitzner/brittany/
 bug-reports:          https://github.com/lspitzner/brittany/issues
-extra-doc-files:
+extra-doc-files: {
  ChangeLog.md
  README.md
  doc/implementation/*.md
-extra-source-files:
-  data/brittany.yaml
-  data/*.hs
+}
+extra-source-files: {
+  src-literatetests/*.blt
+  srcinc/prelude.inc
+}

-source-repository head
+source-repository head {
  type: git
  location: https://github.com/lspitzner/brittany.git
+}

-flag pedantic
+flag brittany-dev-lib
+  description: set buildable false for anything but lib
  default: False
-  description: Enables @-Werror@, which turns warnings into errors.
  manual: True

-common library
-  build-depends:
-    , aeson ^>= 2.0.1
-    , base ^>= 4.15.0
-    , butcher ^>= 1.3.3
-    , bytestring ^>= 0.10.12
-    , cmdargs ^>= 0.10.21
-    , containers ^>= 0.6.4
-    , czipwith ^>= 1.0.1
-    , data-tree-print ^>= 0.1.0
-    , deepseq ^>= 1.4.5
-    , directory ^>= 1.3.6
-    , extra ^>= 1.7.10
-    , filepath ^>= 1.4.2
-    , ghc ^>= 9.0.1
-    , ghc-boot ^>= 9.0.1
-    , ghc-boot-th ^>= 9.0.1
-    , ghc-exactprint ^>= 0.6.4
-    , monad-memo ^>= 0.5.3
-    , mtl ^>= 2.2.2
-    , multistate ^>= 0.8.0
-    , pretty ^>= 1.1.3
-    , random ^>= 1.2.1
-    , safe ^>= 0.3.19
-    , semigroups ^>= 0.19.2
-    , strict ^>= 0.4.0
-    , syb ^>= 0.7.2
-    , text ^>= 1.2.5
-    , transformers ^>= 0.5.6
-    , uniplate ^>= 1.6.13
-    , yaml ^>= 0.11.7
-  default-language: Haskell2010
-  ghc-options:
-    -Weverything
-    -Wno-all-missed-specialisations
-    -Wno-incomplete-uni-patterns
-    -Wno-missing-deriving-strategies
-    -Wno-missing-export-lists
-    -Wno-missing-import-lists
-    -Wno-missing-local-signatures
-    -Wno-missing-safe-haskell-mode
-    -Wno-monomorphism-restriction
-    -Wno-prepositive-qualified-module
-    -Wno-safe
-    -Wno-unsafe
+flag brittany-test-perf
+  description: determines if performance test suite is enabled
+  default: False
+  manual: True

-  if flag(pedantic)
-    ghc-options: -Werror
-
-common executable
-  import: library
-
-  build-depends: brittany
-  ghc-options:
-    -rtsopts
-    -threaded
-    -Wno-implicit-prelude
-    -Wno-unused-packages
-
-library
-  import: library
-
-  autogen-modules: Paths_brittany
-  hs-source-dirs: source/library
-  exposed-modules:
+library {
+  default-language:
+    Haskell2010
+  hs-source-dirs:
+    src
+  include-dirs:
+    srcinc
+  exposed-modules: {
    Language.Haskell.Brittany
+    Language.Haskell.Brittany.Main
    Language.Haskell.Brittany.Internal
-    Language.Haskell.Brittany.Internal.Backend
-    Language.Haskell.Brittany.Internal.BackendUtils
+    Language.Haskell.Brittany.Internal.Prelude
+    Language.Haskell.Brittany.Internal.PreludeUtils
+    Language.Haskell.Brittany.Internal.Types
+    Language.Haskell.Brittany.Internal.Utils
    Language.Haskell.Brittany.Internal.Config
    Language.Haskell.Brittany.Internal.Config.Types
    Language.Haskell.Brittany.Internal.Config.Types.Instances
-    Language.Haskell.Brittany.Internal.ExactPrintUtils
+    Language.Haskell.Brittany.Internal.Obfuscation
+    Paths_brittany
+  }
+  other-modules: {
    Language.Haskell.Brittany.Internal.LayouterBasics
-    Language.Haskell.Brittany.Internal.Layouters.DataDecl
+    Language.Haskell.Brittany.Internal.Backend
+    Language.Haskell.Brittany.Internal.BackendUtils
+    Language.Haskell.Brittany.Internal.ExactPrintUtils
+    Language.Haskell.Brittany.Internal.Layouters.Type
    Language.Haskell.Brittany.Internal.Layouters.Decl
    Language.Haskell.Brittany.Internal.Layouters.Expr
+    Language.Haskell.Brittany.Internal.Layouters.Stmt
+    Language.Haskell.Brittany.Internal.Layouters.Pattern
    Language.Haskell.Brittany.Internal.Layouters.IE
    Language.Haskell.Brittany.Internal.Layouters.Import
    Language.Haskell.Brittany.Internal.Layouters.Module
-    Language.Haskell.Brittany.Internal.Layouters.Pattern
-    Language.Haskell.Brittany.Internal.Layouters.Stmt
-    Language.Haskell.Brittany.Internal.Layouters.Type
-    Language.Haskell.Brittany.Internal.Obfuscation
-    Language.Haskell.Brittany.Internal.ParseModule
-    Language.Haskell.Brittany.Internal.Prelude
-    Language.Haskell.Brittany.Internal.PreludeUtils
+    Language.Haskell.Brittany.Internal.Layouters.DataDecl
    Language.Haskell.Brittany.Internal.Transformations.Alt
-    Language.Haskell.Brittany.Internal.Transformations.Columns
    Language.Haskell.Brittany.Internal.Transformations.Floating
-    Language.Haskell.Brittany.Internal.Transformations.Indent
    Language.Haskell.Brittany.Internal.Transformations.Par
-    Language.Haskell.Brittany.Internal.Types
-    Language.Haskell.Brittany.Internal.Utils
-    Language.Haskell.Brittany.Main
-    Paths_brittany
+    Language.Haskell.Brittany.Internal.Transformations.Columns
+    Language.Haskell.Brittany.Internal.Transformations.Indent
+  }
+  ghc-options: {
+    -Wall
+    -fno-warn-unused-imports
+    -fno-warn-redundant-constraints
+  }
+  build-depends:
+    { base >=4.12 && <4.15
+    , ghc >=8.6.1 && <8.11
+    , ghc-paths >=0.1.0.9 && <0.2
+    , ghc-exactprint >=0.5.8 && <0.6.5
+    , transformers >=0.5.2.0 && <0.6
+    , containers >=0.5.7.1 && <0.7
+    , mtl >=2.2.1 && <2.3
+    , text >=1.2 && <1.3
+    , multistate >=0.7.1.1 && <0.9
+    , syb >=0.6 && <0.8
+    , data-tree-print
+    , pretty >=1.1.3.3 && <1.2
+    , bytestring >=0.10.8.1 && <0.11
+    , directory >=1.2.6.2 && <1.4
+    , butcher >=1.3.1 && <1.4
+    , yaml >=0.8.18 && <0.12
+    , aeson >=1.0.1.0 && <1.6
+    , extra >=1.4.10 && <1.8
+    , uniplate >=1.6.12 && <1.7
+    , strict >=0.3.2 && <0.5
+    , monad-memo >=0.4.1 && <0.6
+    , unsafe >=0.0 && <0.1
+    , safe >=0.3.9 && <0.4
+    , deepseq >=1.4.2.0 && <1.5
+    , semigroups >=0.18.2 && <0.20
+    , cmdargs >=0.10.14 && <0.11
+    , czipwith >=1.0.1.0 && <1.1
+    , ghc-boot-th >=8.6.1 && <8.11
+    , filepath >=1.4.1.0 && <1.5
+    , random >= 1.1 && <1.3
+    }
+  default-extensions: {
+    CPP
+
+    NoImplicitPrelude
+
+    GADTs
+
+    FlexibleContexts
+    FlexibleInstances
+    ScopedTypeVariables
+    MonadComprehensions
+    LambdaCase
+    MultiWayIf
+    KindSignatures
+  }
+}

 executable brittany
-  import: executable
-
-  hs-source-dirs: source/executable
-  main-is: Main.hs
-
-test-suite brittany-test-suite
-  import: executable
-
+  if flag(brittany-dev-lib) {
+    buildable: False
+  } else {
+    buildable: True
+  }
+  main-is:             Main.hs
+  hs-source-dirs:      src-brittany
  build-depends:
-    , hspec ^>= 2.8.3
-  hs-source-dirs: source/test-suite
-  main-is: Main.hs
-  type: exitcode-stdio-1.0
+    { base
+    , brittany
+    }
+  default-language:    Haskell2010
+  ghc-options: {
+    -Wall
+    -fno-spec-constr
+    -fno-warn-unused-imports
+    -fno-warn-redundant-constraints
+    -rtsopts
+    -with-rtsopts "-M2G"
+  }
+
+test-suite unittests
+  if flag(brittany-dev-lib) || !flag(brittany-test-perf) {
+    buildable: False
+  } else {
+    buildable: True
+  }
+  type:             exitcode-stdio-1.0
+  default-language: Haskell2010
+  build-depends:
+    { brittany
+    , base
+    , ghc
+    , ghc-paths
+    , ghc-exactprint
+    , transformers
+    , containers
+    , mtl
+    , text
+    , multistate
+    , syb
+    , data-tree-print
+    , pretty
+    , bytestring
+    , directory
+    , butcher
+    , yaml
+    , aeson
+    , extra
+    , uniplate
+    , strict
+    , monad-memo
+    , unsafe
+    , safe
+    , deepseq
+    , semigroups
+    , cmdargs
+    , czipwith
+    , ghc-boot-th
+    , hspec >=2.4.1 && <2.9
+    }
+  main-is:          TestMain.hs
+  other-modules:    TestUtils
+                    AsymptoticPerfTests
+  hs-source-dirs:   src-unittests
+  include-dirs:     srcinc
+  default-extensions: {
+    CPP
+
+    NoImplicitPrelude
+
+    GADTs
+
+    FlexibleContexts
+    FlexibleInstances
+    ScopedTypeVariables
+    MonadComprehensions
+    LambdaCase
+    MultiWayIf
+    KindSignatures
+  }
+  ghc-options: {
+    -Wall
+    -fno-warn-unused-imports
+    -rtsopts
+    -with-rtsopts "-M2G"
+    -threaded
+    -- ^ threaded is not necessary at all, but our CI trusts on being able
+    --   to pass -N1, which is not possible without threaded :-/
+    --   (plus -no-threaded is not a thing, afaict)
+  }
+
+test-suite littests
+  if flag(brittany-dev-lib) {
+    buildable: False
+  } else {
+    buildable: True
+  }
+  type:             exitcode-stdio-1.0
+  default-language: Haskell2010
+  build-depends:
+    { brittany
+    , base
+    , ghc
+    , ghc-paths
+    , ghc-exactprint
+    , transformers
+    , containers
+    , mtl
+    , text
+    , multistate
+    , syb
+    , data-tree-print
+    , pretty
+    , bytestring
+    , directory
+    , butcher
+    , yaml
+    , aeson
+    , extra
+    , uniplate
+    , strict
+    , monad-memo
+    , unsafe
+    , safe
+    , deepseq
+    , semigroups
+    , cmdargs
+    , czipwith
+    , ghc-boot-th
+    , hspec >=2.4.1 && <2.9
+    , filepath
+    , parsec >=3.1.11 && <3.2
+    }
+  main-is:          Main.hs
+  other-modules:
+  hs-source-dirs:   src-literatetests
+  include-dirs:     srcinc
+  default-extensions: {
+    CPP
+
+    NoImplicitPrelude
+
+    GADTs
+
+    FlexibleContexts
+    FlexibleInstances
+    ScopedTypeVariables
+    MonadComprehensions
+    LambdaCase
+    MultiWayIf
+    KindSignatures
+  }
+  ghc-options: {
+    -Wall
+    -fno-warn-unused-imports
+    -threaded
+    -rtsopts
+    -with-rtsopts "-M2G -N"
+  }
+
+test-suite libinterfacetests
+  if flag(brittany-dev-lib) {
+    buildable: False
+  } else {
+    buildable: True
+  }
+  type:             exitcode-stdio-1.0
+  default-language: Haskell2010
+  build-depends:
+    { brittany
+    , base
+    , text
+    , transformers
+    , hspec >=2.4.1 && <2.9
+    }
+  main-is:          Main.hs
+  other-modules:
+  hs-source-dirs:   src-libinterfacetests
+  include-dirs:     srcinc
+  default-extensions: {
+    FlexibleContexts
+    FlexibleInstances
+    ScopedTypeVariables
+    MonadComprehensions
+    LambdaCase
+    MultiWayIf
+    KindSignatures
+  }
+  ghc-options: {
+    -Wall
+    -fno-warn-unused-imports
+    -rtsopts
+    -with-rtsopts "-M2G"
+    -threaded
+    -- ^ threaded is not necessary at all, but our CI trusts on being able
+    --   to pass -N1, which is not possible without threaded :-/
+    --   (plus -no-threaded is not a thing, afaict)
+  }
--- a/brittany.yaml
+++ b/brittany.yaml
@ -1,4 +0,0 @@
-conf_layout:
-  lconfig_columnAlignMode:
-    tag: ColumnAlignModeDisabled
-  lconfig_indentPolicy: IndentPolicyLeft
--- a/cabal.project
+++ b/cabal.project
@ -1,9 +0,0 @@
-packages: .
-
-allow-newer:
-    -- https://github.com/lspitzner/butcher/issues/7
-    , butcher:base
-    -- https://github.com/lspitzner/data-tree-print/pull/2
-    , data-tree-print:base
-    -- https://github.com/lspitzner/multistate/pull/8
-    , multistate:base
--- a/data/Test1.hs
+++ b/data/Test1.hs
@ -1 +0,0 @@
-func :: a -> a
--- a/data/Test10.hs
+++ b/data/Test10.hs
@ -1,3 +0,0 @@
-func
-  :: lkasdlkjalsdjlakjsdlkjasldkjalskdjlkajsd
-  -> (lakjsdlkjasldkj -> lakjsdlkjasldkj)
--- a/data/Test100.hs
+++ b/data/Test100.hs
@ -1 +0,0 @@
-func = klajsdas klajsdas klajsdas
--- a/data/Test101.hs
+++ b/data/Test101.hs
@ -1,3 +0,0 @@
-func = lakjsdlajsdljasdlkjasldjasldjasldjalsdjlaskjd
-  lakjsdlajsdljasdlkjasldjasldjasldjalsdjlaskjd
-  lakjsdlajsdljasdlkjasldjasldjasldjalsdjlaskjd
--- a/data/Test102.hs
+++ b/data/Test102.hs
@ -1,3 +0,0 @@
-func = lakjsdlajsdljasdlkjasldjasldjasldjalsdjlaskjd lakjsdlajsdljas
-                                                     lakjsdlajsdljas
-                                                     lakjsdlajsdljas
--- a/data/Test103.hs
+++ b/data/Test103.hs
@ -1 +0,0 @@
-func = (1 +)
--- a/data/Test104.hs
+++ b/data/Test104.hs
@ -1 +0,0 @@
-func = (+ 1)
--- a/data/Test105.hs
+++ b/data/Test105.hs
@ -1 +0,0 @@
-func = (1 `abc`)
--- a/data/Test106.hs
+++ b/data/Test106.hs
@ -1 +0,0 @@
-func = (`abc` 1)
--- a/data/Test107.hs
+++ b/data/Test107.hs
@ -1 +0,0 @@
-func = (abc, def)
--- a/data/Test108.hs
+++ b/data/Test108.hs
@ -1 +0,0 @@
-func = (abc, )
--- a/data/Test109.hs
+++ b/data/Test109.hs
@ -1 +0,0 @@
-func = (, abc)
--- a/data/Test11.hs
+++ b/data/Test11.hs
@ -1,3 +0,0 @@
-func
-  :: (lkasdlkjalsdjlakjsdlkjasldkjalskdjlkajsd -> lakjsdlkjasldkj)
-  -> lakjsdlkjasldkj
--- a/data/Test110.hs
+++ b/data/Test110.hs
@ -1,6 +0,0 @@
-myTupleSection =
-  ( verylaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaargefirstelement
-  ,
-  , verylaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaargethirdelement
-  ,
-  )
--- a/data/Test111.hs
+++ b/data/Test111.hs
@ -1,4 +0,0 @@
-func =
-  ( lakjsdlajsdljasdlkjasldjasldjasldjalsdjlaskjd
-  , lakjsdlajsdljasdlkjasldjasldjasldjalsdjlaskjd
-  )
--- a/data/Test112.hs
+++ b/data/Test112.hs
@ -1,6 +0,0 @@
-foo = if True
-  then
-      -- iiiiii
-    "a                                                                         "
-  else
-    "b                                                                         "
--- a/data/Test113.hs
+++ b/data/Test113.hs
@ -1,5 +0,0 @@
-func = if cond
-  then pure 42
-  else do
-    -- test
-    abc
--- a/data/Test114.hs
+++ b/data/Test114.hs
@ -1,3 +0,0 @@
-func = case x of
-  False -> False
-  True  -> True
--- a/data/Test115.hs
+++ b/data/Test115.hs
@ -1,7 +0,0 @@
-func =
-  case
-      lakjsdlajsdljasdlkjasldjasldjasldjalsdjlaskjd
-        lakjsdlajsdljasdlkjasldjasldjasldjalsdjlaskjd
-    of
-      False -> False
-      True  -> True
--- a/data/Test116.hs
+++ b/data/Test116.hs
@ -1,7 +0,0 @@
-func = do
-  case
-      lakjsdlajsdljasdlkjasldjasldjasldjalsdjlaskjd
-        lakjsdlajsdljasdlkjasldjasldjasldjalsdjlaskjd
-    of
-      False -> False
-      True  -> True
--- a/data/Test117.hs
+++ b/data/Test117.hs
@ -1 +0,0 @@
-func = case x of {}
--- a/data/Test118.hs
+++ b/data/Test118.hs
@ -1,5 +0,0 @@
-func =
-  case
-      lakjsdlajsdljasdlkjasldjasldjasldjalsdjlaskjd
-        lakjsdlajsdljasdlkjasldjasldjasldjalsdjlaskjd
-    of {}
--- a/data/Test119.hs
+++ b/data/Test119.hs
@ -1,5 +0,0 @@
-func = do
-  case
-      lakjsdlajsdljasdlkjasldjasldjasldjalsdjlaskjd
-        lakjsdlajsdljasdlkjasldjasldjasldjalsdjlaskjd
-    of {}
--- a/data/Test12.hs
+++ b/data/Test12.hs
@ -1,5 +0,0 @@
-func
-  :: (  lkasdlkjalsdjlakjsdlkjasldkjalskdjlkajsd
-     -> lkasdlkjalsdjlakjsdlkjasldkjalskdjlkajsd
-     )
-  -> lakjsdlkjasldkj
--- a/data/Test120.hs
+++ b/data/Test120.hs
@ -1,3 +0,0 @@
-func = do
-  stmt
-  stmt
--- a/data/Test121.hs
+++ b/data/Test121.hs
@ -1,3 +0,0 @@
-func = do
-  x <- stmt
-  stmt x
--- a/data/Test122.hs
+++ b/data/Test122.hs
@ -1,3 +0,0 @@
-func = do
-  let x = 13
-  stmt x
--- a/data/Test123.hs
+++ b/data/Test123.hs
@ -1,7 +0,0 @@
-func =
-  foooooo
-    $ [ case
-          foooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo
-        of
-          _ -> True
-      ]
--- a/data/Test124.hs
+++ b/data/Test124.hs
@ -1,4 +0,0 @@
-testMethod foo bar baz qux =
-  let x = undefined foo bar baz qux qux baz bar :: String
-  -- some comment explaining the in expression
-  in  undefined foo x :: String
--- a/data/Test125.hs
+++ b/data/Test125.hs
@ -1,4 +0,0 @@
-testMethod foo bar baz qux =
-  let x = undefined :: String
-  -- some comment explaining the in expression
-  in  undefined :: String
--- a/data/Test126.hs
+++ b/data/Test126.hs
@ -1,3 +0,0 @@
-testMethod foo bar baz qux =
-  -- some comment explaining the in expression
-  let x = undefined :: String in undefined :: String
--- a/data/Test127.hs
+++ b/data/Test127.hs
@ -1,6 +0,0 @@
-foo foo bar baz qux =
-  let a = 1
-      b = 2
-      c = 3
-  -- some comment explaining the in expression
-  in  undefined :: String
--- a/data/Test128.hs
+++ b/data/Test128.hs
@ -1,6 +0,0 @@
-func =
-  foo
-    $  [ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
-       , bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
-       ]
-    ++ [ccccccccccccccccccccccccccccccccccccccccccccccccccccccccc]
--- a/data/Test129.hs
+++ b/data/Test129.hs
@ -1 +0,0 @@
-module Main where
--- a/data/Test13.hs
+++ b/data/Test13.hs
@ -1,5 +0,0 @@
-func
-  :: ( (  lkasdlkjalsdjlakjsdlkjasldkjalskdjlkajsd
-       -> lkasdlkjalsdjlakjsdlkjasldkjalskdjlkajsd
-       )
-     )
--- a/data/Test130.hs
+++ b/data/Test130.hs
@ -1 +0,0 @@
-module Main () where
--- a/data/Test131.hs
+++ b/data/Test131.hs
@ -1 +0,0 @@
-module Main (main) where
--- a/data/Test132.hs
+++ b/data/Test132.hs
@ -1 +0,0 @@
-module Main (main, test1, test2) where
--- a/data/Test133.hs
+++ b/data/Test133.hs
@ -1,12 +0,0 @@
-module Main
-  ( main
-  , test1
-  , test2
-  , test3
-  , test4
-  , test5
-  , test6
-  , test7
-  , test8
-  , test9
-  ) where
--- a/data/Test134.hs
+++ b/data/Test134.hs
@ -1,12 +0,0 @@
-module Main
-  ( main
-  -- main
-  , test1
-  , test2
-  -- Test 3
-  , test3
-  , test4
-  -- Test 5
-  , test5
-  -- Test 6
-  ) where
--- a/data/Test135.hs
+++ b/data/Test135.hs
@ -1 +0,0 @@
-module Main (Test(..)) where
--- a/data/Test136.hs
+++ b/data/Test136.hs
@ -1 +0,0 @@
-module Main (module Main) where
--- a/data/Test137.hs
+++ b/data/Test137.hs
@ -1 +0,0 @@
-module Main (Test(Test, a, b)) where
--- a/data/Test138.hs
+++ b/data/Test138.hs
@ -1,6 +0,0 @@
-- comment1
-module Main
-  ( Test(Test, a, b)
-  , foo -- comment2
-  ) -- comment3
-    where
--- a/data/Test139.hs
+++ b/data/Test139.hs
@ -1 +0,0 @@
-module Main (Test()) where
--- a/data/Test14.hs
+++ b/data/Test14.hs
@ -1 +0,0 @@
-func :: asd -> Either a b
--- a/data/Test140.hs
+++ b/data/Test140.hs
@ -1 +0,0 @@
-- Intentionally left empty
--- a/data/Test141.hs
+++ b/data/Test141.hs
@ -1 +0,0 @@
-import           Data.List
--- a/data/Test142.hs
+++ b/data/Test142.hs
@ -1 +0,0 @@
-import           Data.List                               as L
--- a/data/Test143.hs
+++ b/data/Test143.hs
@ -1 +0,0 @@
-import qualified Data.List
--- a/data/Test144.hs
+++ b/data/Test144.hs
@ -1 +0,0 @@
-import qualified Data.List                               as L
--- a/data/Test145.hs
+++ b/data/Test145.hs
@ -1 +0,0 @@
-import safe      Data.List                               as L
--- a/data/Test146.hs
+++ b/data/Test146.hs
@ -1 +0,0 @@
-import {-# SOURCE #-} Data.List                           ( )
--- a/data/Test147.hs
+++ b/data/Test147.hs
@ -1 +0,0 @@
-import safe qualified Data.List
--- a/data/Test148.hs
+++ b/data/Test148.hs
@ -1 +0,0 @@
-import {-# SOURCE #-} safe qualified Data.List
--- a/data/Test149.hs
+++ b/data/Test149.hs
@ -1 +0,0 @@
-import qualified "base" Data.List
--- a/data/Test15.hs
+++ b/data/Test15.hs
@ -1,5 +0,0 @@
-func
-  :: asd
-  -> Either
-       lkasdlkjalsdjlakjsdlkjasldkjalskdjlkajsd
-       lkasdlkjalsdjlakjsdlkjasldkjalskdjlkajsd
--- a/data/Test150.hs
+++ b/data/Test150.hs
@ -1,3 +0,0 @@
-import {-# SOURCE #-} safe qualified "base" Data.List    as L
-import {-# SOURCE #-} safe qualified "base" Data.List     ( )
-import {-# SOURCE #-} safe qualified Data.List     hiding ( )
--- a/data/Test151.hs
+++ b/data/Test151.hs
@ -1 +0,0 @@
-import qualified Data.List                                ( )
--- a/data/Test152.hs
+++ b/data/Test152.hs
@ -1 +0,0 @@
-import           Data.List                                ( nub )
--- a/data/Test153.hs
+++ b/data/Test153.hs
@ -1,4 +0,0 @@
-import           Data.List                                ( foldl'
-                                                          , indexElem
-                                                          , nub
-                                                          )
--- a/data/Test154.hs
+++ b/data/Test154.hs
@ -1,14 +0,0 @@
-import           Test                                     ( Long
-                                                          , anymore
-                                                          , fit
-                                                          , items
-                                                          , line
-                                                          , list
-                                                          , not
-                                                          , onA
-                                                          , quite
-                                                          , single
-                                                          , that
-                                                          , will
-                                                          , with
-                                                          )
--- a/data/Test155.hs
+++ b/data/Test155.hs
@ -1,11 +0,0 @@
-import           Test                                     ( (+)
-                                                          , (:!)(..)
-                                                          , (:*)((:.), T7, t7)
-                                                          , (:.)
-                                                          , T
-                                                          , T2()
-                                                          , T3(..)
-                                                          , T4(T4)
-                                                          , T5(T5, t5)
-                                                          , T6((<|>))
-                                                          )
--- a/data/Test156.hs
+++ b/data/Test156.hs
@ -1,3 +0,0 @@
-import           Test                              hiding ( )
-import           Test                                    as T
-                                                   hiding ( )
--- a/data/Test157.hs
+++ b/data/Test157.hs
@ -1,13 +0,0 @@
-import           Prelude                                 as X
-                                                   hiding ( head
-                                                          , init
-                                                          , last
-                                                          , maximum
-                                                          , minimum
-                                                          , pred
-                                                          , read
-                                                          , readFile
-                                                          , succ
-                                                          , tail
-                                                          , undefined
-                                                          )
--- a/data/Test158.hs
+++ b/data/Test158.hs
@ -1,3 +0,0 @@
-import           TestJustAbitToLongModuleNameLikeThisOneIs
-                                                          ( )
-import           TestJustShortEnoughModuleNameLikeThisOne ( )
--- a/data/Test159.hs
+++ b/data/Test159.hs
@ -1,3 +0,0 @@
-import           TestJustAbitToLongModuleNameLikeThisOneI
-                                                         as T
-import           TestJustShortEnoughModuleNameLikeThisOn as T
--- a/data/Test16.hs
+++ b/data/Test16.hs
@ -1,6 +0,0 @@
-func
-  :: asd
-  -> Trither
-       lkasdlkjalsdjlakjsdlkjasldkjalskdjlkajsd
-       lkasdlkjalsdjlakjsdlkjasldkjalskdjlkajsd
-       lkasdlkjalsdjlakjsdlkjasldkjalskdjlkajsd
--- a/data/Test160.hs
+++ b/data/Test160.hs
@ -1,3 +0,0 @@
-import           TestJustAbitToLongModuleNameLikeTh
-                                                   hiding ( )
-import           TestJustShortEnoughModuleNameLike hiding ( )
--- a/data/Test161.hs
+++ b/data/Test161.hs
@ -1,10 +0,0 @@
-import           MoreThanSufficientlyLongModuleNameWithSome
-                                                          ( compact
-                                                          , fit
-                                                          , inA
-                                                          , items
-                                                          , layout
-                                                          , not
-                                                          , that
-                                                          , will
-                                                          )
--- a/data/Test162.hs
+++ b/data/Test162.hs
@ -1,11 +0,0 @@
-import           TestJustAbitToLongModuleNameLikeTh
-                                                   hiding ( abc
-                                                          , def
-                                                          , ghci
-                                                          , jklm
-                                                          )
-import           TestJustShortEnoughModuleNameLike hiding ( abc
-                                                          , def
-                                                          , ghci
-                                                          , jklm
-                                                          )
--- a/data/Test163.hs
+++ b/data/Test163.hs
@ -1,9 +0,0 @@
-import {-# SOURCE #-} safe qualified "qualifier" A hiding ( )
-import {-# SOURCE #-} safe qualified "qualifiers" A
-                                                   hiding ( )
-import {-# SOURCE #-} safe qualified "qualifiers" AlsoAf as T
-import {-# SOURCE #-} safe qualified "qualifiers" AlsoAff ( )
-import {-# SOURCE #-} safe qualified "qualifiers" AlsoAff
-                                                         as T
-import {-# SOURCE #-} safe qualified "qualifiers" AlsoAffe
-                                                          ( )
--- a/data/Test164.hs
+++ b/data/Test164.hs
@ -1,7 +0,0 @@
-- Test
-import           Data.List                                ( nub ) -- Test
-{- Test -}
-import qualified Data.List                               as L
-                                                          ( foldl' ) {- Test -}
-- Test
-import           Test                                     ( test )
--- a/data/Test165.hs
+++ b/data/Test165.hs
@ -1,4 +0,0 @@
-import           Test                                     ( abc
-                                                          , def
-                                                          -- comment
-                                                          )
--- a/data/Test166.hs
+++ b/data/Test166.hs
@ -1,3 +0,0 @@
-import           Test                                     ( abc
-                                                          -- comment
-                                                          )
--- a/data/Test167.hs
+++ b/data/Test167.hs
@ -1,8 +0,0 @@
-import           Test                                     ( abc
-                                                          -- comment
-                                                          , def
-                                                          , ghi
-                                                          {- comment -}
-                                                          , jkl
-                                                          -- comment
-                                                          )
--- a/data/Test168.hs
+++ b/data/Test168.hs
@ -1,2 +0,0 @@
-import           Test                                     ( -- comment
-                                                          )
--- a/data/Test169.hs
+++ b/data/Test169.hs
@ -1,8 +0,0 @@
-import           Test                                     ( longbindingNameThatoverflowsColum
-                                                          )
-import           Test                                     ( Long
-                                                            ( List
-                                                            , Of
-                                                            , Things
-                                                            )
-                                                          )
--- a/data/Test17.hs
+++ b/data/Test17.hs
@ -1,6 +0,0 @@
-func
-  :: Trither
-       lkasdlkjalsdjlakjsdlkjasldkjalskdjlkajsd
-       lkasdlkjalsdjlakjsdlkjasldkjalskdjlkajsd
-       lkasdlkjalsdjlakjsdlkjasldkjalskdjlkajsd
-  -> asd
--- a/data/Test170.hs
+++ b/data/Test170.hs
@ -1,18 +0,0 @@
-import           Test                                     ( Thing
-                                                            ( -- Comments
-                                                            )
-                                                          )
-import           Test                                     ( Thing
-                                                            ( Item
-                                                            -- and Comment
-                                                            )
-                                                          )
-import           Test                                     ( Thing
-                                                            ( With
-                                                            -- Comments
-                                                            , and
-                                                            -- also
-                                                            , items
-                                                            -- !
-                                                            )
-                                                          )
--- a/data/Test171.hs
+++ b/data/Test171.hs
@ -1,2 +0,0 @@
-import           VeryLongModuleNameThatCouldEvenCauseAnEmptyBindingListToExpandIntoMultipleLine
-                                                          ( )
--- a/data/Test172.hs
+++ b/data/Test172.hs
@ -1,26 +0,0 @@
-{-# LANGUAGE BangPatterns #-}
-{-
- - Test module
- -}
-module Test
-  ( test1
-  -- ^ test
-  , test2
-  -- | test
-  , test3
-  , test4
-  , test5
-  , test6
-  , test7
-  , test8
-  , test9
-  , test10
-  -- Test 10
-  ) where
-- Test
-import           Data.List                                ( nub ) -- Test
-{- Test -}
-import qualified Data.List                               as L
-                                                          ( foldl' ) {- Test -}
-- Test
-import           Test                                     ( test )
--- a/data/Test173.hs
+++ b/data/Test173.hs
@ -1,2 +0,0 @@
-import           Aaa
-import           Baa
--- a/data/Test174.hs
+++ b/data/Test174.hs
@ -1,5 +0,0 @@
-import           Zaa
-import           Zab
-
-import           Aaa
-import           Baa
--- a/data/Test175.hs
+++ b/data/Test175.hs
@ -1,2 +0,0 @@
-import           Boo
-import qualified Zoo
--- a/Show More
+++ b/Show More
				`@ -1 +0,0 @@`
				`import {-# SOURCE #-} safe qualified Data.List`