Skeletest.Main

Documentation

runSkeletest :: [Plugin] -> [(FilePath, String, Spec)] -> IO ()

CLI flags

data Flag

Register a CLI flag.

Usage:

{- MyFixture.hs -}
import Skeletest

newtype MyFlag = MyFlag String
instance IsFlag MyFlag where
  flagName = "my-flag"
  flagHelp = "The value for MyFixture"
  flagSpec =
    OptionalFlag
      { flagDefault = "foo"
      , flagParse = case
          "illegal" -> Left "invalid flag value"
          s -> Right (MyFlag s)
      }

instance Fixture MyFixture where
  fixtureAction = do
    MyFlag val <- getFlag
    ...

{- Main.hs -}
import MyFixture

cliFlags =
  [ flag @MyFlag
  ]

flag :: IsFlag a => Flag

Snapshots

data SnapshotRenderer

Constructors

Typeable a => SnapshotRenderer

Fields

• render :: a -> Text
• snapshotLang :: Maybe Text

renderWithShow :: (Typeable a, Show a) => SnapshotRenderer

Plugins

data Plugin

Instances

Monoid Plugin

Defined in Skeletest.Plugin

Methods

mempty :: Plugin

mappend :: Plugin -> Plugin -> Plugin

mconcat :: [Plugin] -> Plugin

Semigroup Plugin

Defined in Skeletest.Plugin

Methods

(<>) :: Plugin -> Plugin -> Plugin

sconcat :: NonEmpty Plugin -> Plugin

stimes :: Integral b => b -> Plugin -> Plugin

Re-exports

type Spec = Spec' ()