Test.DocTest.Internal.Parse

Documentation

data Module a

Documentation for a module grouped together with the modules name.

Constructors

Module

Fields

• moduleName :: String
• moduleSetup :: Maybe a
• moduleContent :: [a]
• moduleConfig :: [Located String]

Instances

Functor Module

Defined in Test.DocTest.Internal.Extract

Methods

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

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

Eq a => Eq (Module a)

Defined in Test.DocTest.Internal.Extract

Methods

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

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

Show a => Show (Module a)

Defined in Test.DocTest.Internal.Extract

Methods

showsPrec :: Int -> Module a -> ShowS

show :: Module a -> String

showList :: [Module a] -> ShowS

Generic (Module a)

Defined in Test.DocTest.Internal.Extract

Associated Types

type Rep (Module a) :: Type -> Type

Methods

from :: Module a -> Rep (Module a) x

to :: Rep (Module a) x -> Module a

NFData a => NFData (Module a)

Defined in Test.DocTest.Internal.Extract

Methods

rnf :: Module a -> ()

type Rep (Module a)

Defined in Test.DocTest.Internal.Extract

type Rep (Module a) = D1 ('MetaData "Module" "Test.DocTest.Internal.Extract" "doctest-parallel-0.2.6-inplace" 'False) (C1 ('MetaCons "Module" 'PrefixI 'True) ((S1 ('MetaSel ('Just "moduleName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :*: S1 ('MetaSel ('Just "moduleSetup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe a))) :*: (S1 ('MetaSel ('Just "moduleContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [a]) :*: S1 ('MetaSel ('Just "moduleConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Located String]))))

data DocTest

Constructors

Example Expression ExpectedResult

Property Expression

Instances

Eq DocTest

Defined in Test.DocTest.Internal.Parse

Methods

(==) :: DocTest -> DocTest -> Bool

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

Show DocTest

Defined in Test.DocTest.Internal.Parse

Methods

showsPrec :: Int -> DocTest -> ShowS

show :: DocTest -> String

showList :: [DocTest] -> ShowS

type Interaction = (Expression, ExpectedResult)

type Expression = String

type ExpectedResult = [ExpectedLine]

data ExpectedLine

Constructors

ExpectedLine [LineChunk]

WildCardLine

Instances

Eq ExpectedLine

Defined in Test.DocTest.Internal.Parse

Methods

(==) :: ExpectedLine -> ExpectedLine -> Bool

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

Show ExpectedLine

Defined in Test.DocTest.Internal.Parse

Methods

showsPrec :: Int -> ExpectedLine -> ShowS

show :: ExpectedLine -> String

showList :: [ExpectedLine] -> ShowS

IsString ExpectedLine

Defined in Test.DocTest.Internal.Parse

Methods

fromString :: String -> ExpectedLine

data LineChunk

Constructors

LineChunk String

WildCardChunk

Instances

Eq LineChunk

Defined in Test.DocTest.Internal.Parse

Methods

(==) :: LineChunk -> LineChunk -> Bool

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

Show LineChunk

Defined in Test.DocTest.Internal.Parse

Methods

showsPrec :: Int -> LineChunk -> ShowS

show :: LineChunk -> String

showList :: [LineChunk] -> ShowS

IsString LineChunk

Defined in Test.DocTest.Internal.Parse

Methods

fromString :: String -> LineChunk

getDocTests

Arguments

:: [String]

-> IO [Module [Located DocTest]]

Extracted DocTests

Extract DocTests from all given modules and all modules included by the given modules.

exported for testing

parseInteractions :: Located String -> [Located Interaction]

Extract all interactions from given Haddock comment.

parseProperties :: Located String -> [Located Expression]

Extract all properties from given Haddock comment.

mkLineChunks :: String -> [LineChunk]