Safe Haskell	None
Language	GHC2021

Freckle.App.Test.DocTest

Contents

Lower-level, for site-specific use

Synopsis

doctest :: FilePath -> IO ()
doctestWith :: [String] -> FilePath -> IO ()
findPackageFlags :: IO [String]
findDocTestedFiles :: FilePath -> IO [FilePath]

Documentation

doctest :: FilePath -> IO () Source #

Run doctest on files in the given directory

doctestWith :: [String] -> FilePath -> IO () Source #

Run doctest on files in the given directory and with additional flags

Lower-level, for site-specific use

findPackageFlags :: IO [String] Source #

findDocTestedFiles :: FilePath -> IO [FilePath] Source #

Find any source files with doctest comments

Doctest with a lot of files is really slow. Like really slow:

https://github.com/sol/doctest/issues/141

Also, some suites won't actually work on a lot of our files because of some instance-import-related debt that we don't have the time to clean up at this time:

https://freckleinc.slack.com/archives/C459XJBGR/p1519220418000125

So we want to only run doctest for files that need it. This function finds such files by naively looking for the ^-- >>> pattern.