doctest-discover

Easy way to run doctests via cabal

Monthly Downloads: 41

Programming language: Haskell

License: LicenseRef-PublicDomain

Tags: Testing     Doctest    

README

PROJECT NO LONGER MAINTAINED. MIGHT CONSIDER A REWRITE IN THE FUTURE

doctest-discover

• Do you have to maintain a list of source files that cabal needs to use to run doctests?

doctest-discover (inspired by hspec-discover) makes it easy to run doctests via cabal.

doctest-discover is published on hackage

The only thing you need to do is create a driver file with one line (let's call it doctest-driver.hs):

{-# OPTIONS_GHC -F -pgmF doctest-discover #-}

Use it as the main for the test-suite in your cabal file:

test-suite cooler-doctests
  default-language:   Haskell2010
  type:               exitcode-stdio-1.0
  ghc-options:        -threaded
  main-is:            doctest-driver.hs
  build-depends:      base >4 && <5, doctest, doctest-discover
  HS-Source-Dirs:     test

doctest-discover is used as a pre-processor. Since there is nothing to pre-process in the file, it builds a temporary file with the code needed to run doctests via cabal.

Configuration

Configuration has to be specified in a json file. Make sure you put the config file in the root directory of your project.

To use a config file, change your driver to add the config file name with the -optF flag.

{-# OPTIONS_GHC -F -pgmF doctest-discover -optF config.json #-}

Ignoring files

{
    "ignore": ["foo.hs", "bar.hs", "baz.hs"]
}

Source folders

{
    "ignore": ["foo.hs", "bar.hs", "baz.hs"],
    "sourceFolders": ["src", "src/foobar", "someOtherSource"]
}

Contributors

Richard Cook