Test.Hspec.Api.Format.V2

Documentation

type Format = Event -> IO ()

data FormatConfig

Since: 2.11.5

Constructors

FormatConfig

Fields

• formatConfigUseColor :: Bool
• formatConfigReportProgress :: Bool
• formatConfigOutputUnicode :: Bool
• formatConfigUseDiff :: Bool
• formatConfigDiffContext :: Maybe Int
• formatConfigExternalDiff :: Maybe (String -> String -> IO ())
• formatConfigPrettyPrintFunction :: Maybe (String -> String -> (String, String))
• formatConfigFormatException :: SomeException -> String

  Since: 2.11.5

• formatConfigPrintTimes :: Bool
• formatConfigHtmlOutput :: Bool
• formatConfigPrintCpuTime :: Bool
• formatConfigUsedSeed :: Integer
• formatConfigExpectedTotalCount :: Int

defaultFormatConfig :: FormatConfig

data Event

Constructors

Started

GroupStarted Path

GroupDone Path

Progress Path Progress

ItemStarted Path

ItemDone Path Item

Done [(Path, Item)]

Instances

Show Event

Defined in Test.Hspec.Core.Format

Methods

showsPrec :: Int -> Event -> ShowS

show :: Event -> String

showList :: [Event] -> ShowS

type Progress = (Int, Int)

type Path = ([String], String)

A Path describes the location of a spec item within a spec tree.

It consists of a list of group descriptions and a requirement description.

Since: hspec-core-2.0.0

data Location

Location is used to represent source locations.

Constructors

Location

Fields

• locationFile :: FilePath
• locationLine :: Int
• locationColumn :: Int

Instances

Read Location

Defined in Test.Hspec.Core.Example.Location

Methods

readsPrec :: Int -> ReadS Location

readList :: ReadS [Location]

readPrec :: ReadPrec Location

readListPrec :: ReadPrec [Location]

Show Location

Defined in Test.Hspec.Core.Example.Location

Methods

showsPrec :: Int -> Location -> ShowS

show :: Location -> String

showList :: [Location] -> ShowS

Eq Location

Defined in Test.Hspec.Core.Example.Location

Methods

(==) :: Location -> Location -> Bool

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

newtype Seconds

Constructors

Seconds Double

Instances

Num Seconds

Defined in Test.Hspec.Core.Clock

Methods

(+) :: Seconds -> Seconds -> Seconds

(-) :: Seconds -> Seconds -> Seconds

(*) :: Seconds -> Seconds -> Seconds

negate :: Seconds -> Seconds

abs :: Seconds -> Seconds

signum :: Seconds -> Seconds

fromInteger :: Integer -> Seconds

Fractional Seconds

Defined in Test.Hspec.Core.Clock

Methods

(/) :: Seconds -> Seconds -> Seconds

recip :: Seconds -> Seconds

fromRational :: Rational -> Seconds

Show Seconds

Defined in Test.Hspec.Core.Clock

Methods

showsPrec :: Int -> Seconds -> ShowS

show :: Seconds -> String

showList :: [Seconds] -> ShowS

PrintfArg Seconds

Defined in Test.Hspec.Core.Clock

Methods

formatArg :: Seconds -> FieldFormatter

parseFormat :: Seconds -> ModifierParser

Eq Seconds

Defined in Test.Hspec.Core.Clock

Methods

(==) :: Seconds -> Seconds -> Bool

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

Ord Seconds

Defined in Test.Hspec.Core.Clock

Methods

compare :: Seconds -> Seconds -> Ordering

(<) :: Seconds -> Seconds -> Bool

(<=) :: Seconds -> Seconds -> Bool

(>) :: Seconds -> Seconds -> Bool

(>=) :: Seconds -> Seconds -> Bool

max :: Seconds -> Seconds -> Seconds

min :: Seconds -> Seconds -> Seconds

data Item

Constructors

Item

Fields

• itemLocation :: Maybe Location
• itemDuration :: Seconds
• itemInfo :: String
• itemResult :: Result

Instances

Show Item

Defined in Test.Hspec.Core.Format

Methods

showsPrec :: Int -> Item -> ShowS

show :: Item -> String

showList :: [Item] -> ShowS

data Result

Constructors

Success

Pending (Maybe Location) (Maybe String)

Failure (Maybe Location) FailureReason

Instances

Show Result

Defined in Test.Hspec.Core.Format

Methods

showsPrec :: Int -> Result -> ShowS

show :: Result -> String

showList :: [Result] -> ShowS

data FailureReason

Constructors

NoReason

Reason String

ColorizedReason String

ExpectedButGot (Maybe String) String String

Error (Maybe String) SomeException

Instances

Show FailureReason

Defined in Test.Hspec.Core.Example

Methods

showsPrec :: Int -> FailureReason -> ShowS

show :: FailureReason -> String

showList :: [FailureReason] -> ShowS

NFData FailureReason

Defined in Test.Hspec.Core.Example

Methods

rnf :: FailureReason -> ()

monadic :: MonadIO m => (m () -> IO ()) -> (Event -> m ()) -> IO Format

Register a formatter

registerFormatter :: (String, FormatConfig -> IO Format) -> Config -> Config

Make a formatter available for use with --format.

useFormatter :: (String, FormatConfig -> IO Format) -> Config -> Config

Make a formatter available for use with --format and use it by default.

liftFormatter :: (String, FormatConfig -> IO Format) -> (String, FormatConfig -> IO Format)

Make a formatter compatible with types from Test.Hspec.Core.Format.

Re-exports

type SpecWith a = SpecM a ()

data Config

modifyConfig :: (Config -> Config) -> SpecWith a

Since: hspec-core-2.10.0