Web app

.github/workflows/ci.yml

@@ -1,10 +1,11 @@
 name: CI
 
 # Trigger the workflow on push or pull request, but only for the master branch
-on:
-  pull_request:
-  push:
-    branches: [master]
+# TODO use this trigger once deploy tested
+# on:
+#   pull_request:
+#   push:
+#     branches: [master]
 
 jobs:
   cabal:
@@ -23,8 +24,9 @@ jobs:
           - "8.4.4"
           - "8.6.5"
           - "8.8.4"
-          - "8.10.4"
-          - "9.0.1"
+          - "8.10.7"
+          - "9.0.2"
+          - "9.2.4"
 
     steps:
     - uses: actions/checkout@v2
@@ -46,11 +48,24 @@ jobs:
     - name: Build
       run: |
         cabal update
-        cabal build all --enable-tests --enable-benchmarks --write-ghc-environment-files=always --flags="buildexample"
+        # TODO: We have a problem where cabal is not able to come up with a
+        # build plan on GHC-9.2 because the ./cabal.project file defines both
+        # pretty-simple, and ./web as packages. ./web uses a version of jsaddle
+        # that doesn't seem to work yet on GHC-9.2.  It doesn't seem possible
+        # to tell cabal to just ignore the web package, and only run the solver
+        # for pretty-simple.
+        #
+        # This hacky workaround just deletes the cabal.project file, so that
+        # cabal doesn't realize there is another package in ./web.
+        #
+        # This workaround can likely be removed when we move to a more recent
+        # version of jsaddle.
+        rm ./cabal.project
+        cabal build package:pretty-simple --enable-tests --enable-benchmarks --write-ghc-environment-files=always --flags="buildexample"
 
     - name: Test
       run: |
-        cabal test all --enable-tests
+        cabal test package:pretty-simple --enable-tests
 
   stack:
     name: stack / ubuntu-latest
@@ -83,3 +98,15 @@ jobs:
       run: |
         stack test
 
+  nix-build-web:
+    name: Nix build GHCJS web
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: cachix/install-nix-action@v16
+        with:
+          extra_nix_config: |
+            trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= miso-haskell.cachix.org-1:6N2DooyFlZOHUfJtAx1Q09H0P5XXYzoxxQYiwn6W1e8=
+            substituters = https://cache.nixos.org/ https://miso-haskell.cachix.org
+      - name: Build web
+        run: nix-build ./web

.github/workflows/deploy.yaml

@@ -0,0 +1,27 @@
+# TODO use this trigger once tested
+# on:
+#   push:
+#     branches:
+#       - master
+on:
+  pull_request:
+
+jobs:
+  deploy:
+    name: Nix build and deploy GHCJS web app
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: cachix/install-nix-action@v16
+        with:
+          extra_nix_config: |
+            trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= miso-haskell.cachix.org-1:6N2DooyFlZOHUfJtAx1Q09H0P5XXYzoxxQYiwn6W1e8= haskell-pretty-simple.cachix.org-1:AWHkzPidwcDzWUIUjKcx/PYgud2OBAa9SNUEoIOsATY=
+            substituters = https://cache.nixos.org/ https://miso-haskell.cachix.org https://haskell-pretty-simple.cachix.org
+      - name: Build
+        run: |
+          nix-build ./web
+          cp -rL result result-no-symlinks
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          folder: result-no-symlinks/bin/web.jsexe

.gitignore

@@ -16,3 +16,4 @@ cabal.sandbox.config
 *.hp
 *.eventlog
 .stack-work/
+web/result

cabal.project

@@ -0,0 +1,12 @@
+packages:
+  .
+  web
+
+constraints: miso +jsaddle
+
+-- https://github.com/ghcjs/jsaddle/pull/133
+source-repository-package
+  type: git
+  location: https://github.com/avanov/jsaddle
+  tag: 838a2133f15085c5b6b75bdd0647ac5033c59380
+  subdir: jsaddle jsaddle-warp

src/Text/Pretty/Simple/Internal/Printer.hs

@@ -195,9 +195,11 @@ hCheckTTY h options = liftIO $ conv <$> tty
 -- suitable for passing to any /prettyprinter/ backend.
 -- Used by 'Simple.pString' etc.
 layoutString :: OutputOptions -> String -> SimpleDocStream Style
-layoutString opts =
-  annotateStyle opts
-    . removeTrailingWhitespace
+layoutString opts = annotateStyle opts . layoutStringAbstract opts
+
+layoutStringAbstract :: OutputOptions -> String -> SimpleDocStream Annotation
+layoutStringAbstract opts =
+    removeTrailingWhitespace
     . layoutSmart defaultLayoutOptions
       {layoutPageWidth = AvailablePerLine (outputOptionsPageWidth opts) 1}
     . indent (outputOptionsInitialIndent opts)
@@ -302,6 +304,7 @@ data Annotation
   | Quote
   | String
   | Num
+  deriving (Eq, Show)
 
 -- | Replace non-printable characters with hex escape sequences.
 --

web/README.md

@@ -0,0 +1,16 @@
+
+# pretty-simple Web Page
+
+This directory contains an interactive web page that can be compiled with GHCJS
+to show how `pretty-simple` works.
+
+This Haskell package can be built with GHCJS with the command `nix-build`.
+You'll need Nix [installed](https://nixos.org/download.html) for this to work.
+You'll also need to setup the Miso Nix cache, as explained
+[here](https://github.com/cdepillabout/pretty-simple/pull/117#issuecomment-1258023974).
+
+This Haskell package can also be built with GHC with the command `cabal build web`.
+Running this executable with `cabal run web` will start a web server listening on
+`0.0.0.0:8000`.  You should be able to see the web page by opening
+<http://localhost:8000> in a web browser.  _Note_ that you will need to run
+`cabal run web` within this current directory.

web/default.nix

@@ -0,0 +1,40 @@
+with (import
+  (builtins.fetchTarball {
+    url =
+      "https://github.com/dmjio/miso/archive/refs/tags/1.8.3.tar.gz";
+    sha256 = "0kcr5agbcynm003zj70yfkhsc169ahdcp9pkyr795p5mc3ykycjl";
+  })
+{ });
+#TODO we can remove all these patches once we're not stuck on such old tools
+# unfortunately GHCJS 8.10.7 has serious performance issues: https://github.com/dmjio/miso/pull/693
+let
+  hp = pkgs.haskell.packages.ghcjs86.override {
+    all-cabal-hashes = builtins.fetchurl {
+      url =
+        "https://github.com/commercialhaskell/all-cabal-hashes/archive/ead1bd926a1b10b04a5c07c8f15827091fa98b38.tar.gz";
+      sha256 = "15i7ia241wb3s9f6l9n2bqldb4ii73xrj49rfr02q43iqbmdjddv";
+    };
+  };
+  prettyprinter = hp.callHackage "prettyprinter" "1.7.0" { };
+  prettyprinter-ansi-terminal =
+    hp.callHackage "prettyprinter-ansi-terminal" "1.1.2" {
+      prettyprinter = prettyprinter;
+    };
+  app = hp.callCabal2nix "web" ./. {
+    prettyprinter = prettyprinter;
+    pretty-simple = hp.callCabal2nix "pretty-simple" ./.. {
+      prettyprinter = prettyprinter;
+      prettyprinter-ansi-terminal = prettyprinter-ansi-terminal;
+    };
+  };
+in
+pkgs.buildEnv {
+  name = "pretty-simple-web";
+  paths = [
+    app
+    (pkgs.runCommand "css" { } ''
+      mkdir -p $out/bin/web.jsexe
+      cp ${./style.css} $out/bin/web.jsexe/style.css
+    '')
+  ];
+}