-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/

-- | Hspec support for the Tasty test framework.
--   
--   This package provides a Tasty provider for Hspec test suites.
@package tasty-hspec
@version 1.2.0.3

-- | hspec and tasty serve similar purposes; consider
--   using one or the other.
--   
--   However, in a pinch, this module allows you to run an hspec
--   Spec as a tasty TestTree.
module Test.Tasty.Hspec

-- | Create a tasty TestTree from an hspec
--   Spec.
testSpec :: TestName -> Spec -> IO TestTree

-- | Create a list of tasty TestTree from an hspec
--   Spec. This returns the same tests as testSpec but
--   doesn't create a tasty test group from them.
testSpecs :: Spec -> IO [TestTree]

-- | How to treat hspec pending tests.
--   
--   tasty does not have the concept of pending tests, so we must
--   map them to either successes or failures. By default, they are treated
--   as failures.
--   
--   Set via the command line flag --treat-pending-as
--   (success|failure).
data TreatPendingAs

-- | Default.
TreatPendingAsFailure :: TreatPendingAs
TreatPendingAsSuccess :: TreatPendingAs
instance Test.Tasty.Core.IsTest Test.Tasty.Hspec.Item
instance Test.Tasty.Options.IsOption Test.Tasty.Hspec.TreatPendingAs
