The cabal-doctest package

[Tags:bsd3, library]

Currently (beginning of 2017), there isn't cabal doctest command. Yet, to properly work doctest needs plenty of configuration. This library provides the common bits for writing custom Setup.hs See Cabal/2327 for the progress of cabal doctest, i.e. whether this library is obsolete.


[Skip to Readme]

Properties

Versions 1
Change log ChangeLog.md
Dependencies base (>=4.3 && <4.11), Cabal (>=1.10 && <2.1), directory, filepath [details]
License BSD3
Copyright (c) 2017 Oleg Grenrus
Author Oleg Grenrus <oleg.grenrus@iki.fi>
Maintainer Oleg Grenrus <oleg.grenrus@iki.fi>
Stability Unknown
Category Distribution
Home page https://github.com/phadej/cabal-doctests
Source repository head: git clone https://github.com/phadej/cabal-doctest
Uploaded Tue Jan 31 17:30:44 UTC 2017 by phadej
Distributions LTSHaskell:1, NixOS:1, Stackage:1, Tumbleweed:1
Downloads 24 total (12 in the last 30 days)
Votes
1 []
Status Docs available [build log]
Last success reported on 2017-01-31 [all 1 reports]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for cabal-doctest

Readme for cabal-doctest-1

cabal-doctest

Hackage Build Status

A Setup.hs helper for running doctests.

Example Usage

To use this library in your Setup.hs, you should specify a custom-setup section in your .cabal file. For example:

custom-setup
 setup-depends:
   base >= 4 && <5,
   cabal-doctest >= 1 && <1.1

You'll also need to specify build-type: Custom at the top of the .cabal file. Now put this into your Setup.hs file:

module Main where

import Distribution.Extra.Doctest (defaultMainWithDoctests)

main :: IO ()
main = defaultMainWithDoctests "doctests"

When you build your project, this Setup will generate a Build_doctests module. To use it in a testsuite, simply do this:

module Main where

import Build_doctests (flags, pkgs, module_sources)
import Data.Foldable (traverse_)
import Test.Doctest (doctest)

main :: IO ()
main = do
    traverse_ putStrLn args -- optionally print arguments
    doctest args
  where
    args = flags ++ pkgs ++ module_sources

Notes

  • custom-setup section is supported starting from cabal-install-1.24. For older cabal-install's you have to install custom setup dependencies manually.

  • stack respects custom-setup starting from version 1.3.3. Before that you have to use explicit-setup-deps setting in your stack.yaml. (stack/GH-2094)

  • There is [an issue in the Cabal issue tracker](https://github.com/haskell/cabal/issues/2327 Cabal/2327) about adding cabal doctest command. After that command is implemented, this library will be deprecated.

Copyright

Copyright 2017 Oleg Grenrus.

Available under the BSD 3-clause license.