Prepare for preview release

- rename to »prettyprinter«
- don’t export Unicode module until I know where to put it
- update README

README.md

@@ -2,18 +2,27 @@
 
 
 
-Prettyprinter à la Wadler/Leijen
-================================
-
-<span style="color: red">This project is not officially released yet. Since it
-is reasonably stable and bug-free, you’re invited to try it out; I (quchen) used
-it in production for months. Please do not publish it on my behalf though, I’d
-like to do this myself once I’m happy with everything. :-) </span>
+A modern Wadler/Leijen Prettyprinter
+====================================
 
 [![status](https://img.shields.io/github/release/quchen/prettyprinter.svg?style=flat-square&label=Latest%20version)](https://github.com/quchen/prettyprinter/releases)
 [![status](https://img.shields.io/travis/quchen/prettyprinter/master.svg?style=flat-square&label=Master%20build)](https://travis-ci.org/quchen/prettyprinter)
 
-This module defines a prettyprinter to format text in a flexible and convenient
+
+
+tl;dr
+-----
+
+A prettyprinter/text rendering engine. Easy to use, well-documented, ANSI
+terminal backend exists, HTML backend is trivial to implement, no name clashes,
+Text-based, extensible.
+
+
+
+Longer; want to read
+--------------------
+
+This package defines a prettyprinter to format text in a flexible and convenient
 way. The idea is to combine a document out of many small components, then using
 a layouter to convert it to an easily renderable simple document, which can then
 be rendered to a variety of formats, for example plain `Text`, or Markdown.
@@ -108,21 +117,23 @@ exposed in a semi-internal module for this specific use case.
 
 
 
-The wl-pprint family
---------------------
+The prettyprinter family
+------------------------
+
+The `prettyprinter` family of packages consists of:
 
-The `wl-pprint` family of packages consists of:
-
-  - `wl-pprint` is the core package. It defines the language to generate nicely
-    laid out documents, which can then be given to renderers to display them in
-    various ways, e.g. HTML, or plain text.
-  - `wl-pprint-ansi` provides a renderer suitable for ANSI terminal output
-    including colors (at the cost of a dependency more).
-  - `wl-pprint-compat-old` provides a drop-in compatibility layer for previous
-    users of the old `wl-pprint`. Use it for easy adaption of the new
-    `wl-pprint`, but don't develop anything new with it.
-  - `wl-pprint-compat-old-ansi` is the same, but for previous users of
+  - `prettyprinter` is the core package. It defines the language to generate
+    nicely laid out documents, which can then be given to renderers to display
+    them in various ways, e.g. HTML, or plain text.
+  - `prettyprinter-ansi-terminal` provides a renderer suitable for ANSI terminal
+    output including colors (at the cost of a dependency more).
+  - `prettyprinter-compat-wl-pprint` provides a drop-in compatibility layer for
+    previous users of the `wl-pprint` package. Use it for easy adaption of the
+    new `prettyprinter`, but don't develop anything new with it.
+  - `prettyprinter-compat-ansi-wl-pprint` is the same, but for previous users of
     `ansi-wl-pprint`.
+  - `prettyprinter-compat-annotated-wl-pprint` is the same, but for previous
+    users of `annotated-wl-pprint`.
 
 
 

cabal.project

@@ -1,9 +1,10 @@
 -- http://cabal.readthedocs.io/en/latest/nix-local-build-overview.html
 
-packages: wl-pprint
-        , wl-pprint-ansi
-        , wl-pprint-compat-old
-        , wl-pprint-compat-old-ansi
+packages: 'prettyprinter'
+        , 'prettyprinter-ansi-terminal'
+        , 'prettyprinter-compat-wl-pprint'
+        , 'prettyprinter-compat-ansi-wl-pprint'
+        , 'prettyprinter-compat-annotated-wl-pprint'
 
 tests: true
 benchmarks: true

wl-pprint-ansi/wl-pprint-ansi.cabal → prettyprinter-ansi-terminal/prettyprinter-ansi-terminal.cabal

@@ -1,5 +1,5 @@
-name:                wl-pprint-ansi
-version:             1
+name:                prettyprinter-ansi-terminal
+version:             0.1
 cabal-version:       >= 1.10
 category:            User Interfaces, Text
 synopsis:            ANSI terminal backend for the modern, extensible and well-documented prettyprinter.
@@ -35,7 +35,7 @@ library
           base < 127
         , ansi-terminal >= 0.4.0 && < 0.7
         , text
-        , wl-pprint
+        , prettyprinter >= 0 && < 0.2
 
     if impl(ghc >= 8.0)
         ghc-options: -Wcompat

wl-pprint-compat-old-annotated-wl-pprint/wl-pprint-compat-old-annotated-wl-pprint.cabal → prettyprinter-compat-annotated-wl-pprint/prettyprinter-compat-annotated-wl-pprint.cabal

@@ -1,5 +1,5 @@
-name:                wl-pprint-compat-old-annotated-wl-pprint
-version:             1
+name:                prettyprinter-compat-annotated-wl-pprint
+version:             0.1
 cabal-version:       >= 1.10
 category:            User Interfaces, Text
 synopsis:            Prettyprinter compatibility module for previous users of the annotated-wl-pprint package.
@@ -29,4 +29,4 @@ library
     build-depends:
           base < 127
         , text
-        , wl-pprint
+        , prettyprinter >= 0 && < 0.2

wl-pprint-compat-old-ansi/wl-pprint-compat-old-ansi.cabal → prettyprinter-compat-ansi-wl-pprint/prettyprinter-compat-ansi-wl-pprint.cabal

@@ -1,5 +1,5 @@
-name:                wl-pprint-compat-old-ansi
-version:             1
+name:                prettyprinter-compat-ansi-wl-pprint
+version:             0.1
 cabal-version:       >= 1.10
 category:            User Interfaces, Text
 synopsis:            Prettyprinter compatibility module for previous users of the ansi-wl-pprint package.
@@ -31,5 +31,5 @@ library
     build-depends:
           base < 127
         , text
-        , wl-pprint
-        , wl-pprint-ansi
+        , prettyprinter >= 0 && < 0.2
+        , prettyprinter-ansi-terminal >= 0 && < 0.2

wl-pprint-compat-old/wl-pprint-compat-old.cabal → prettyprinter-compat-wl-pprint/prettyprinter-compat-wl-pprint.cabal

@@ -1,4 +1,4 @@
-name:                wl-pprint-compat-old
+name:                prettyprinter-compat-wl-pprint
 version:             1
 cabal-version:       >= 1.10
 category:            User Interfaces, Text
@@ -31,4 +31,4 @@ library
     build-depends:
           base < 127
         , text
-        , wl-pprint
+        , prettyprinter >= 0 && < 0.2

wl-pprint/app/GenerateReadme.hs → prettyprinter/app/GenerateReadme.hs

@@ -27,25 +27,26 @@ readmeContents :: Doc ann
 readmeContents = (mconcat . L.intersperse vspace)
     [ htmlComment "This file was auto-generated by the 'scripts/generate_readme' program."
 
-    , h1 "Prettyprinter à la Wadler/Leijen"
-
-    , paragraph [multiline| <span style="color: red">This project is not
-    officially released yet. Since it is reasonably stable and bug-free, you’re
-    invited to try it out; I (quchen) used it in production for months. Please
-    do not publish it on my behalf though, I’d like to do this myself once I’m
-    happy with everything. :-) </span>|]
+    , h1 "A modern Wadler/Leijen Prettyprinter"
 
     , cat
         [ "[![status](https://img.shields.io/github/release/quchen/prettyprinter.svg?style=flat-square&label=Latest%20version)](https://github.com/quchen/prettyprinter/releases)"
         , "[![status](https://img.shields.io/travis/quchen/prettyprinter/master.svg?style=flat-square&label=Master%20build)](https://travis-ci.org/quchen/prettyprinter)"
         ]
 
-    , paragraph [multiline| This module defines a prettyprinter to format text
-    in a flexible and convenient way. The idea is to combine a document out of
-    many small components, then using a layouter to convert it to an easily
-    renderable simple document, which can then be rendered to a variety of
-    formats, for example plain `Text`, or Markdown. *What you are reading right
-    now was generated by this library (see `GenerateReadme.hs`).* |]
+    , h2 "tl;dr"
+        , paragraph [multiline| A prettyprinter/text rendering engine. Easy to
+        use, well-documented, ANSI terminal backend exists, HTML backend is
+        trivial to implement, no name clashes, Text-based, extensible. |]
+
+    , h2 "Longer; want to read"
+        , paragraph [multiline| This package defines a prettyprinter to format
+        text in a flexible and convenient way. The idea is to combine a document
+        out of many small components, then using a layouter to convert it to an
+        easily renderable simple document, which can then be rendered to a
+        variety of formats, for example plain `Text`, or Markdown. *What you are
+        reading right now was generated by this library (see
+        `GenerateReadme.hs`).* |]
 
     , h2 "Why another prettyprinter?"
         , paragraph [multiline| Haskell, more specifically Hackage, has a zoo of
@@ -115,21 +116,24 @@ readmeContents = (mconcat . L.intersperse vspace)
         island of incompatibility. For this reason, the `Doc` type is fully
         exposed in a semi-internal module for this specific use case. |]
 
-
-    , h2 "The wl-pprint family"
-    , paragraph "The `wl-pprint` family of packages consists of:"
+    , h2 "The prettyprinter family"
+    , paragraph "The `prettyprinter` family of packages consists of:"
     , (indent 2 . unorderedList . map paragraph)
-        [ [multiline| `wl-pprint` is the core package. It defines the language
-          to generate nicely laid out documents, which can then be given to
-          renderers to display them in various ways, e.g. HTML, or plain text.|]
-        , [multiline| `wl-pprint-ansi` provides a renderer suitable for ANSI
-          terminal output including colors (at the cost of a dependency more).|]
-        , [multiline| `wl-pprint-compat-old` provides a drop-in compatibility
-          layer for previous users of the old `wl-pprint`. Use it for easy
-          adaption of the new `wl-pprint`, but don't develop anything new with
-          it.|]
-        , [multiline| `wl-pprint-compat-old-ansi` is the same, but for previous
-          users of `ansi-wl-pprint`.|]
+        [ [multiline| `prettyprinter` is the core package. It defines the
+          language to generate nicely laid out documents, which can then be
+          given to renderers to display them in various ways, e.g. HTML, or
+          plain text.|]
+        , [multiline| `prettyprinter-ansi-terminal` provides a renderer suitable
+          for ANSI terminal output including colors (at the cost of a
+          dependency more).|]
+        , [multiline| `prettyprinter-compat-wl-pprint` provides a drop-in
+          compatibility layer for previous users of the `wl-pprint` package. Use
+          it for easy adaption of the new `prettyprinter`, but don't develop
+          anything new with it.|]
+        , [multiline| `prettyprinter-compat-ansi-wl-pprint` is the same, but for
+          previous users of `ansi-wl-pprint`.|]
+        , [multiline| `prettyprinter-compat-annotated-wl-pprint` is the same,
+          but for previous users of `annotated-wl-pprint`.|]
         ]
 
     , h2 "Differences to the old Wadler/Leijen prettyprinters"

wl-pprint/wl-pprint.cabal → prettyprinter/prettyprinter.cabal

@@ -1,5 +1,5 @@
-name:                wl-pprint
-version:             1
+name:                prettyprinter
+version:             0.1
 cabal-version:       >= 1.10
 category:            User Interfaces, Text
 synopsis:            A modern, extensible and well-documented prettyprinter.
@@ -35,8 +35,9 @@ library
         , Data.Text.Prettyprint.Doc.Render.Util.Panic
         , Data.Text.Prettyprint.Doc.Render.Util.SimpleDocTree
         , Data.Text.Prettyprint.Doc.Render.Util.StackMachine
-        , Data.Text.Prettyprint.Doc.Unicode
         , Data.Text.Prettyprint.Doc.Util
+        -- Hidden for now, until I figure out where to put it:
+        -- , Data.Text.Prettyprint.Doc.Unicode
     ghc-options: -Wall
     hs-source-dirs: src
     include-dirs: aux
@@ -68,7 +69,7 @@ executable generate_readme
     main-is: GenerateReadme.hs
     build-depends:
           base < 127
-        , wl-pprint
+        , prettyprinter
         , text
         , template-haskell
     default-language: Haskell2010
@@ -100,7 +101,7 @@ test-suite testsuite
     main-is: Main.hs
     build-depends:
           base
-        , wl-pprint
+        , prettyprinter
 
         , pgp-wordlist
         , bytestring
@@ -121,13 +122,14 @@ benchmark fusion
     main-is: Fusion.hs
     build-depends:
           base
-        , wl-pprint
-        , ansi-wl-pprint
+        , prettyprinter
+
         , criterion
+        , mtl
         , random
         , text
         , transformers
-        , mtl
+        , ansi-wl-pprint
     ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N
     default-language: Haskell2010
     other-extensions: NumDecimals, OverloadedStrings
@@ -136,7 +138,7 @@ benchmark faster-unsafe-text
     build-depends: base >= 4.7 && < 5
                  , criterion
                  , text
-                 , wl-pprint
+                 , prettyprinter
 
     hs-source-dirs:      bench
     main-is:             FasterUnsafeText.hs

scripts/benchmark

@@ -9,7 +9,7 @@ pwd
 
 OUTDIR="${PROJECT_ROOT}/generated"
 mkdir -p "$OUTDIR"
-stack bench wl-pprint \
+stack bench prettyprinter:bench:fusion \
     --benchmark-arguments "--output \"$OUTDIR/wl-pprint-benchmark.html\""
-stack bench faster-unsafe-text \
+stack bench prettyprinter:bench:faster-unsafe-text \
     --benchmark-arguments "--output \"$OUTDIR/faster-unsafe-text.html\""

scripts/checks/stylish-haskell

@@ -6,7 +6,7 @@ stylish-haskell --version
 
 cd "$(stack path --project-root)"
 git stash
-find wl-pprint* -name "*.hs" -exec stylish-haskell --inplace {} \;
+find prettyprinter* -name "*.hs" -exec stylish-haskell --inplace {} \;
 
 cd "$(git rev-parse --show-toplevel)"
 set +e
@@ -15,11 +15,11 @@ EXIT=$?
 set -e
 
 if [[ $EXIT -ne 0 ]]; then
-    echo '╭────────────────────────────────────────────────────────────────────╮'
-    echo '│ Stylish-Haskell introduced changes.                                │'
-    echo '│ Please run it before committing!                                   │'
-    echo '│                                                                    │'
-    echo '│ find wl-pprint* -name "*.hs" -exec stylish-haskell --inplace {} \; │'
-    echo '╰────────────────────────────────────────────────────────────────────╯'
+    echo '╭────────────────────────────────────────────────────────────────────────╮'
+    echo '│ Stylish-Haskell introduced changes.                                    │'
+    echo '│ Please run it before committing!                                       │'
+    echo '│                                                                        │'
+    echo '│ find prettyprinter* -name "*.hs" -exec stylish-haskell --inplace {} \; │'
+    echo '╰────────────────────────────────────────────────────────────────────────╯'
 fi
 exit $EXIT

scripts/generate_readme

@@ -6,5 +6,5 @@ set -v
 cd "$(git rev-parse --show-toplevel)"
 pwd
 
-stack build wl-pprint:exe:generate_readme
+stack build prettyprinter:exe:generate_readme
 stack exec generate_readme > README.md

stack-older-snapshots.yaml

@@ -1,10 +1,10 @@
 resolver: lts-7.13
 packages:
-    - 'wl-pprint'
-    - 'wl-pprint-ansi'
-    - 'wl-pprint-compat-old'
-    - 'wl-pprint-compat-old-ansi'
-    - 'wl-pprint-compat-old-annotated-wl-pprint'
+    - 'prettyprinter'
+    - 'prettyprinter-ansi-terminal'
+    - 'prettyprinter-compat-wl-pprint'
+    - 'prettyprinter-compat-ansi-wl-pprint'
+    - 'prettyprinter-compat-annotated-wl-pprint'
 extra-deps:
     - pgp-wordlist-0.1.0.2
 flags: {}

stack.yaml

@@ -1,10 +1,10 @@
 resolver: lts-8.0
 packages:
-    - 'wl-pprint'
-    - 'wl-pprint-ansi'
-    - 'wl-pprint-compat-old'
-    - 'wl-pprint-compat-old-ansi'
-    - 'wl-pprint-compat-old-annotated-wl-pprint'
+    - 'prettyprinter'
+    - 'prettyprinter-ansi-terminal'
+    - 'prettyprinter-compat-wl-pprint'
+    - 'prettyprinter-compat-ansi-wl-pprint'
+    - 'prettyprinter-compat-annotated-wl-pprint'
 extra-deps: []
 flags: {}
 extra-package-dbs: []