| Safe Haskell | None |
|---|---|
| Language | GHC2021 |
Skeletest.Main
Synopsis
- runSkeletest :: [Plugin] -> [(FilePath, Spec)] -> IO ()
- data Flag
- flag :: IsFlag a => Flag
- data SnapshotRenderer = Typeable a => SnapshotRenderer {
- render :: a -> Text
- snapshotLang :: Maybe Text
- renderWithShow :: (Typeable a, Show a) => SnapshotRenderer
- data Plugin
- type Spec = SpecM ()
Documentation
CLI flags
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
{ default_ = "foo"
, parse = 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
]
Snapshots
data SnapshotRenderer Source #
Constructors
| Typeable a => SnapshotRenderer | |
Fields
| |
renderWithShow :: (Typeable a, Show a) => SnapshotRenderer Source #
Plugins
A plugin for extending Skeletest.
Use defaultPlugin instead of using Plugin directly, to minimize
breaking changes.