google/ormolu
1
1
Fork 0
mirror of https://github.com/google/ormolu.git synced 2024-09-11 08:05:24 +03:00
Code Issues Projects Releases Wiki Activity

Mention ‘Outputable’ and ‘SDoc’ in the section about pretty printing

Browse Source 
[skip ci]
This commit is contained in:
mrkkrp 2018-12-08 18:13:13 +07:00
parent 912ea9b28d
commit b5e26f8b6f
No known key found for this signature in database
GPG Key ID: 8564658B2889FF7C
1 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
DESIGN.md
View File

@ -257,8 +257,10 @@ Implementation can be just a `Reader` monad producing something like text
builder. The context of `Reader` can store current indentation and
configuration options.
Returning to `ghc-exactprint`, if we'll be printing the AST ourselves it
makes sense to depend on the [`ghc`][ghc] package directly.
As a pretty-printing library we can use [`Outputable`][outputable] (and
`SDoc`) from the [`ghc`][ghc] package itself. The benefit is that AST
components that we'll want to print are already instances of `Outputable`,
so we'll get correct renderings for free.
### Configuration
@ -343,7 +345,7 @@ straightforward:
Proposed roadmap (for a single person, about 39 full-time work days):
* ~~Create and setup a repo, setup CI (less than 1 day).~~
* Implement parsing (2 days).
* ~~Implement parsing (2 days).~~
* Implement basis for pretty-printing of code. We could take
[this][hindent-printer] as inspiration, although AST from the `ghc`
package may be slightly different. Also, don't forget about annotations
@ -372,6 +374,7 @@ Proposed roadmap (for a single person, about 39 full-time work days):
[stylish-haskell]: https://hackage.haskell.org/package/stylish-haskell
[haskell-formatter]: https://hackage.haskell.org/package/haskell-formatter
[ghc]: https://hackage.haskell.org/package/ghc
[outputable]: https://hackage.haskell.org/package/ghc-8.4.3/docs/Outputable.html
[haskell-src-exts]: https://hackage.haskell.org/package/haskell-src-exts
[ghc-exactprint]: https://hackage.haskell.org/package/ghc-exactprint
[hindent-printer]: https://github.com/commercialhaskell/hindent/blob/master/src/HIndent/Pretty.hs