Hackage :: [Package]

print-debugger: Debug print formatting library.

[ debug, library, public-domain ] [ Propose Tags ] [ Report a vulnerability ]

Print debugging with stack trace for Haskell (formatted for ease of use). See screenshot: http://i.imgur.com/KCXYHNk.png

[Skip to Readme]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 0.0, 1.0.0, 1.0.1, 1.1.1, 1.1.2, 1.1.3, 1.1.4, 1.1.5, 1.1.6, 1.1.7, 1.1.8, 1.1.9
Dependencies base (<4.10), split [details]
Tested with ghc ==7.10.3
License LicenseRef-PublicDomain
Author John-Michael Reed
Maintainer johnmichaelreedfas@gmail.com
Category Debug
Home page https://github.com/JohnReedLOL/HaskellPrintDebugger
Bug tracker https://github.com/JohnReedLOL/HaskellPrintDebugger/issues
Source repo head: git clone https://github.com/JohnReedLOL/HaskellPrintDebugger
Uploaded by johnreedlol at 2016-02-14T22:47:35Z
Distributions
Reverse Dependencies 1 direct, 0 indirect [details]
Downloads 6539 total (15 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2016-02-14 [all 1 reports]

Readme for print-debugger-1.1.9

[back to package description]

HaskellPrintDebugger

Prints lines with IDE friendly stack traces in Haskell (now with IDE friendly fatal assertions).

Example:

debugTraceIO "foobar"

foobar in thread "1" :

    at Main.call(Main.hs:41)

See screenshot: http://i.imgur.com/KCXYHNk.png

Dependencies:

  • None (except for "split" package in .cabal). Automatically imports on "cabal install print-debugger".

Instructions:

  1. Add the file "StackTraceDebug.hs" to your Haskell project.
  2. Add "import StackTraceDebug" if you want to call the function
  3. Call "debugTraceIO" with any String argument.
  4. When you are done, remove or comment out all calls to debugTraceIO.
  5. Optionally, set value "debugMode" to "False" in "StackTraceDebug.hs" to mute all calls to "debugTraceIO" and disable all fatal assertions.

Benefits:

  • Does not require to be compiled with "-prof"
  • Easier to locate your print statements (and assertions)- Location of print statement (and assertions) can be highlighted in an IDE
  • Easy to turn print statemments (and assertions) on/off without having to manually uncomment each one.
  • CC0 (Free to use, share, or modify, even commercially)

Requirements:

  • GHC 7.10.1 (or greater)
  • "-XImplicitParams" compiler option
  • "split" package or addition of ", split" to "build-depends" line in ".cabal" file

Configuration:

Sample ".cabal" file:

name: HaskellProject1

version: 1.0

Build-Type: Simple

cabal-version: >= 1.2

executable HaskellProject1

main-is: Main.hs

hs-source-dirs: src

build-depends: base, split

Sample compilation:

    $> ghc StackTraceDebug.hs -Wall -Werror -XImplicitParams

Know bugs:

http://stackoverflow.com/questions/35354153/haskell-cannot-import-ghc-srcloc

^ Doesn't build correctly on Caball Ubuntu 14.04 with old (ubuntu LTS repo) version of GHC.

(but compiles fine on Windows with "ghc StackTraceDebug.hs -Wall -Werror -XImplicitParams")

To report or pinpoint bugs, email johnmichaelreedfas@gmail.com

More info:

http://hackage.haskell.org/package/print-debugger

https://www.reddit.com/r/haskell/comments/45jfk8/my_first_package_enhanced_poor_mans_debugging/

https://github.com/JohnReedLOL/HaskellPrintDebugger/edit/master/README.md