Test.DocTest

Documentation

mainFromCabal :: String -> [String] -> IO ()

Run doctest with given list of arguments.

Example:

mainFromCabal "my-project" =<< getArgs

mainFromLibrary :: Library -> [String] -> IO ()

Like mainFromCabal, but with a given library.

mainFromCabalWithConfig :: String -> Config -> IO ()

Run doctest given config.

Example:

mainFromCabal "my-project" defaultConfig

mainFromLibraryWithConfig :: Library -> Config -> IO ()

Run doctests with given library and config.

Internal

filterModules :: [ModuleName] -> [Module a] -> [Module a]

Filter modules to be tested against a list of modules to be tested (specified by the user on the command line). If list is empty, test all modules. Throws and error if a non-existing module was specified.

isSuccess :: Summary -> Bool

getSeed

Arguments

:: Bool

Whether quiet mode is enabled

-> Bool

Enable order randomization. If False, this function always returns Nothing

-> Maybe Int

User supplied seed. If Nothing, a fresh seed will be generated.

-> IO (Maybe Int)

Maybe seed to use for order randomization.

run :: Library -> Config -> IO Summary

Run doctest for given library and config. Produce a summary of all tests.