Skip to content

Commit 78280dc

Browse files
author
Gaël Deest
committed
Disable hspec colored output in servant-swagger doctests
Colored output is the default since hspec 2.9.5. This causes CI failures due to terminal escaping characters when running the doctests on GitHub Actions.
1 parent c19ed0f commit 78280dc

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

servant-swagger/src/Servant/Swagger.hs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ import Servant.Swagger.Internal.Orphans ()
5555
-- >>> import Data.Typeable
5656
-- >>> import GHC.Generics
5757
-- >>> import Servant.API
58+
-- >>> import System.Environment
5859
-- >>> import Test.Hspec
5960
-- >>> import Test.QuickCheck
6061
-- >>> import qualified Data.ByteString.Lazy.Char8 as BSL8
@@ -64,6 +65,7 @@ import Servant.Swagger.Internal.Orphans ()
6465
-- >>> :set -XGeneralizedNewtypeDeriving
6566
-- >>> :set -XOverloadedStrings
6667
-- >>> :set -XTypeOperators
68+
-- >>> setEnv "HSPEC_COLOR" "no"
6769
-- >>> data User = User { name :: String, age :: Int } deriving (Show, Generic, Typeable)
6870
-- >>> newtype UserId = UserId Integer deriving (Show, Generic, Typeable, ToJSON)
6971
-- >>> instance ToJSON User

servant-swagger/src/Servant/Swagger/Internal/Test.hs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,12 @@ import Servant.Swagger.Internal.TypeLevel
2929
-- >>> import Control.Applicative
3030
-- >>> import GHC.Generics
3131
-- >>> import Test.QuickCheck
32+
-- >>> import System.Environment (setEnv)
3233
-- >>> :set -XDeriveGeneric
3334
-- >>> :set -XGeneralizedNewtypeDeriving
3435
-- >>> :set -XDataKinds
3536
-- >>> :set -XTypeOperators
37+
-- >>> setEnv "HSPEC_COLOR" "no"
3638

3739
-- | Verify that every type used with @'JSON'@ content type in a servant API
3840
-- has compatible @'ToJSON'@ and @'ToSchema'@ instances using @'validateToJSON'@.

0 commit comments

Comments
 (0)