Hackage :: [Package]

haskell-src-exts-sc: Pretty print haskell code with comments

[ bsd3, language, library ] [ Propose Tags ] [ Report a vulnerability ]

Generate code from haskell-src-exts AST. To do it, I pretty print and parse AST, then adjust it to insert comments.

[Skip to Readme]

Modules

[Index]

Flags

Automatic Flags
NameDescriptionDefault
build-example

Build an example executable.

Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.1.0.3, 0.1.0.4, 0.1.0.5, 0.1.0.6 (info)
Dependencies base (>=4.7 && <5), haskell-src-exts (>=1.18.0), haskell-src-exts-sc [details]
License BSD-3-Clause
Copyright Copyright: (c) 2018 Artem Chirkin
Author Artem Chirkin
Maintainer chirkin@arch.ethz.ch
Category bsd3, library, language
Home page https://github.com/achirkin/haskell-src-exts-sc#readme
Source repo head: git clone https://github.com/achirkin/haskell-src-exts-sc
Uploaded by achirkin at 2018-04-10T14:51:25Z
Distributions
Reverse Dependencies 1 direct, 0 indirect [details]
Executables sc-example
Downloads 3596 total (27 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2018-04-13 [all 1 reports]

Readme for haskell-src-exts-sc-0.1.0.6

[back to package description]

haskell-src-exts-sc

The library generates code from haskell-src-exts AST. The procedure is as follows:

  1. pretty-print AST generated by haskell-src-exts
  2. parse the generated code to get SrcSpanInfo for each node
  3. combine AST annotated with comments and AST annotated with SrcSpanInfo
  4. insert (non-empty) comments into each node, updating SrcSpanInfo of all nodes
  5. profit!

As you can see, the algorithm is nor remarkably fast, because it prints and parses code and modifies SrcSpanInfo of all nodes in an AST on each comment insertion. On the good side, it is quite flexible and compatible with many versions of haskell-src-exts. Performance is also acceptable if you don't need to invoke it every millisecond.