pretty-types: A small pretty printing DSL for complex types.
This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.
Warnings:
- The 'description' field should be longer than the 'synopsis' field. It's useful to provide an informative 'description' to allow Haskell programmers who have never heard about your package to understand the purpose of your package. The 'description' field content is typically shown by tooling (e.g. 'cabal info', Haddock, Hackage) below the 'synopsis' which serves as a headline. Please refer to <https://www.haskell.org/cabal/users-guide/developing-packages.html#package-properties> for more details.
- Packages relying on Cabal 1.12 or later should specify a specific version of the Cabal spec of the form 'cabal-version: x.y'. Use 'cabal-version: 1.22'.
Properties
| Versions | 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.0.3, 0.1.1.0, 0.2.0.0, 0.2.1.0, 0.2.2.0, 0.2.2.1, 0.2.3.0, 0.2.3.1, 0.3.0.1, 0.4.0.0, 0.4.0.0 |
|---|---|
| Change log | ChangeLog.md |
| Dependencies | base (>=4.9 && <5), mtl (>=2.2 && <3), tagged (>=0.8 && <1) [details] |
| License | BSD-3-Clause |
| Copyright | 2016-2021 Sven Heyll |
| Author | Sven Heyll |
| Maintainer | sven.heyll@gmail.com |
| Category | Text |
| Home page | https://github.com/sheyll/pretty-types#readme |
| Source repo | head: git clone https://github.com/sheyll/pretty-types |
| Uploaded | by SvenHeyll at 2021-01-25T13:21:37Z |
Modules
[Index] [Quick Jump]
- Data
- Type
Downloads
- pretty-types-0.4.0.0.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
Maintainer's Corner
Package maintainers
For package maintainers and hackage trustees
Readme for pretty-types-0.4.0.0
[back to package description]
Type Pretty Printing
A tiny eDSL, not unlike ErrorMessage for TypeErrors to pretty print types,
especially uninhabited types.
This Example will render this table:
+-------+-----+------------+
| col 1|col 2| col 3|
+-------+-----+------------+
| 2423| 451| 21234|
| 242322| 42| n/a|
| 0| 4351| 623562|
| 4351| n/a| n/a|
| 0| 4351| 623562|
+-------+-----+------------+
From this code:
module Main (main) where
import Data.Type.Pretty
import GHC.TypeLits
import Data.Kind
import Data.Proxy
main :: IO ()
main = putStrLn $ showPretty (Proxy :: Proxy TestTable)
type TestTable =
'MyTable '[MyCol "col 1" 7, MyCol "col 2" 5, MyCol "col 3" 12]
'[ MyRow '[2423 ,451 ,21234]
, MyRow '[242322 ,42]
, MyRow '[0 ,4351 ,623562]
, MyRow '[4351]
, MyRow '[0 ,4351 ,623562]
]
data MyTable = MyTable [Type] [Type]
data MyCol :: Symbol -> Nat -> Type
data MyRow :: [Nat] -> Type
type instance ToPretty ('MyTable cols rows) =
PrettyManyIn (PutStr "+") (RowSepLine cols)
<$$> PrettyManyIn (PutStr "|") (TableHeading cols)
<$$> PrettyManyIn (PutStr "+") (RowSepLine cols)
<$$> PrettyHigh (TableRows cols rows)
<$$> PrettyManyIn (PutStr "+") (RowSepLine cols)
type family TableHeading (cols :: [Type]) :: [PrettyType]
type instance TableHeading '[] = '[]
type instance TableHeading (MyCol title width ': r) =
PutStrW width title ': TableHeading r
type family
RowSepLine (cols :: [Type]) :: [PrettyType] where
RowSepLine '[] = '[]
RowSepLine (MyCol title width ': r) =
PrettyOften width (PutStr "-") ': RowSepLine r
type family
TableRows (cols :: [Type]) (rows :: [Type]) :: [PrettyType] where
TableRows cols '[] = '[]
TableRows cols (MyRow cells ': rest ) =
PrettyManyIn (PutStr "|") (TableCells cols cells) ': TableRows cols rest
type family
TableCells (cols :: [Type]) (cells :: [Nat]) :: [PrettyType] where
TableCells '[] cells = '[]
TableCells (MyCol title width ': cols) (value ': cells) =
PutNatW width value ': TableCells cols cells
TableCells (MyCol title width ': cols) '[] =
PutStrW width "n/a" ': TableCells cols '[]