Test.DocTest.Internal.Options

Documentation

usage :: String

version :: String

ghcVersion :: String

versionInfo :: String

info :: String

data Result a

Constructors

ResultStderr String

ResultStdout String

Result a

Instances

Functor Result

Defined in Test.DocTest.Internal.Options

Methods

fmap :: (a -> b) -> Result a -> Result b

(<$) :: a -> Result b -> Result a

Show a => Show (Result a)

Defined in Test.DocTest.Internal.Options

Methods

showsPrec :: Int -> Result a -> ShowS

show :: Result a -> String

showList :: [Result a] -> ShowS

Eq a => Eq (Result a)

Defined in Test.DocTest.Internal.Options

Methods

(==) :: Result a -> Result a -> Bool

(/=) :: Result a -> Result a -> Bool

type Warning = String

type ModuleName = String

data Config

Constructors

Config

Fields

• cfgLogLevel :: LogLevel

  Verbosity level.

• cfgModules :: [ModuleName]

  Module names to test. An empty list means "test all modules".

• cfgThreads :: Maybe Int

  Number of threads to use. Defaults to autodetection based on the number of cores.

• cfgModuleConfig :: ModuleConfig

  Options specific to modules

• cfgNix :: Bool

  Detect Nix build environment and try to make GHC aware of the local package being tested.

• cfgGhcArgs :: [String]

  Extra arguments passed to GHC when parsing

Instances

Generic Config

Defined in Test.DocTest.Internal.Options

Associated Types

type Rep Config :: Type -> Type

Methods

from :: Config -> Rep Config x

to :: Rep Config x -> Config

Show Config

Defined in Test.DocTest.Internal.Options

Methods

showsPrec :: Int -> Config -> ShowS

show :: Config -> String

showList :: [Config] -> ShowS

NFData Config

Defined in Test.DocTest.Internal.Options

Methods

rnf :: Config -> ()

Eq Config

Defined in Test.DocTest.Internal.Options

Methods

(==) :: Config -> Config -> Bool

(/=) :: Config -> Config -> Bool

type Rep Config

Defined in Test.DocTest.Internal.Options

type Rep Config = D1 ('MetaData "Config" "Test.DocTest.Internal.Options" "doctest-parallel-0.3.1-inplace" 'False) (C1 ('MetaCons "Config" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cfgLogLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LogLevel) :*: (S1 ('MetaSel ('Just "cfgModules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ModuleName]) :*: S1 ('MetaSel ('Just "cfgThreads") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "cfgModuleConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ModuleConfig) :*: (S1 ('MetaSel ('Just "cfgNix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "cfgGhcArgs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [String])))))

data ModuleConfig

Constructors

ModuleConfig

Fields

• cfgPreserveIt :: Bool

  Preserve the it variable between examples (default: False)

• cfgRandomizeOrder :: Bool

  Randomize the order in which test cases in a module are run (default: False)

• cfgSeed :: Maybe Int

  Initialize random number generator used to randomize test cases when cfgRandomizeOrder is set. If set to Nothing, a random seed is picked from a system RNG source on startup.

• cfgImplicitModuleImport :: Bool

  Import a module before testing it. Can be disabled to enabled to test non-exposed modules.

Instances

Generic ModuleConfig

Defined in Test.DocTest.Internal.Options

Associated Types

type Rep ModuleConfig :: Type -> Type

Methods

from :: ModuleConfig -> Rep ModuleConfig x

to :: Rep ModuleConfig x -> ModuleConfig

Show ModuleConfig

Defined in Test.DocTest.Internal.Options

Methods

showsPrec :: Int -> ModuleConfig -> ShowS

show :: ModuleConfig -> String

showList :: [ModuleConfig] -> ShowS

NFData ModuleConfig

Defined in Test.DocTest.Internal.Options

Methods

rnf :: ModuleConfig -> ()

Eq ModuleConfig

Defined in Test.DocTest.Internal.Options

Methods

(==) :: ModuleConfig -> ModuleConfig -> Bool

(/=) :: ModuleConfig -> ModuleConfig -> Bool

type Rep ModuleConfig

Defined in Test.DocTest.Internal.Options

type Rep ModuleConfig = D1 ('MetaData "ModuleConfig" "Test.DocTest.Internal.Options" "doctest-parallel-0.3.1-inplace" 'False) (C1 ('MetaCons "ModuleConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cfgPreserveIt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "cfgRandomizeOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "cfgSeed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "cfgImplicitModuleImport") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))

defaultModuleConfig :: ModuleConfig

defaultConfig :: Config

parseLocatedModuleOptions :: ModuleName -> ModuleConfig -> [Located String] -> Either (Location, String) ModuleConfig

parseModuleOption :: ModuleConfig -> String -> Maybe ModuleConfig

parseOptions :: [String] -> Result Config

parseGhcArg :: String -> Maybe String

Parse ghc-arg argument

>>> parseGhcArg "--ghc-arg=foobar"
Just "foobar"

parseSeed :: String -> Maybe Int

Parse seed argument

>>> parseSeed "--seed=6"
Just 6
>>> parseSeed "--seeeed=6"
Nothing

parseLogLevel :: String -> Maybe LogLevel

Parse seed argument

>>> parseLogLevel "--log-level=Debug"
Just Debug
>>> parseLogLevel "--log-level=debug"
Just Debug
>>> parseSeed "---log-level=debug"
Nothing

parseThreads :: String -> Maybe Int

Parse number of threads argument

>>> parseThreads "-j6"
Just 6
>>> parseThreads "-j-2"
Nothing
>>> parseThreads "-jA"
Nothing

parseSpecificFlag :: String -> String -> Maybe String

Parse a specific flag with a value, or return Nothing

>>> parseSpecificFlag "--foo" "foo"
Nothing
>>> parseSpecificFlag "--foo=" "foo"
Nothing
>>> parseSpecificFlag "--foo=5" "foo"
Just "5"
>>> parseSpecificFlag "--foo=5" "bar"
Nothing

parseFlag :: String -> (String, Maybe String)

Parse a flag into its flag and argument component.

Example:

>>> parseFlag "--optghc=foo"
("--optghc",Just "foo")
>>> parseFlag "--optghc="
("--optghc",Nothing)
>>> parseFlag "--fast"
("--fast",Nothing)