Test.Haddock.Config

Documentation

data TestPackage

Constructors

TestPackage

Fields

• tpkgName :: String
• tpkgFiles :: [FilePath]

data CheckConfig c

Constructors

CheckConfig

Fields

• ccfgRead :: String -> Maybe c

  f contents parses file contents contents to produce a thing to be compared.

• ccfgClean :: String -> c -> c

  f fname x cleans x to such that it can be compared

• ccfgDump :: c -> String
• ccfgEqual :: c -> c -> Bool

data DirConfig

Constructors

DirConfig

Fields

• dcfgSrcDir :: FilePath
• dcfgRefDir :: FilePath
• dcfgOutDir :: FilePath
• dcfgResDir :: FilePath
• dcfgCheckIgnore :: FilePath -> Bool

data Config c

Constructors

Config

Fields

• cfgHaddockPath :: FilePath
• cfgPackages :: [TestPackage]
• cfgHaddockArgs :: [String]
• cfgHaddockStdOut :: FilePath
• cfgDiffTool :: Maybe FilePath
• cfgEnv :: Environment
• cfgAccept :: Bool
• cfgCheckConfig :: CheckConfig c
• cfgDirConfig :: DirConfig

defaultDirConfig :: FilePath -> DirConfig

cfgSrcDir :: Config c -> FilePath

cfgRefDir :: Config c -> FilePath

cfgOutDir :: Config c -> FilePath

cfgResDir :: Config c -> FilePath

parseArgs :: CheckConfig c -> DirConfig -> [String] -> IO (Config c)

checkOpt :: [String] -> IO ([Flag], [String])

loadConfig :: CheckConfig c -> DirConfig -> [Flag] -> [String] -> IO (Config c)