Merge pull request #7 from codewars/rename-to-new-formatter

Author: kazk

README.md

@@ -8,15 +8,19 @@ Specify `codewars` formatter:
 
 ```haskell
 -- test/Main.hs
-module Main where
+module Main (main) where
 
 import Test.Hspec.Runner
-import Test.Hspec.Formatters.Codewars (codewars)
+import Test.Hspec.Formatters.Codewars (newFormatter)
+import Test.Hspec.Core.Formatters.V2 (formatterToFormat)
 
 import qualified Spec
 
 main :: IO ()
-main = hspecWith defaultConfig {configFormatter = Just codewars} Spec.spec
+main = do
+  codewars <- newFormatter
+  runSpec Spec.spec defaultConfig {configFormat = Just $ formatterToFormat codewars}
+  >>= evaluateSummary
 ```
 
 ```haskell

src/Test/Hspec/Formatters/Codewars.hs

@@ -1,6 +1,6 @@
 {-# LANGUAGE OverloadedStrings #-}
 
-module Test.Hspec.Formatters.Codewars (codewars, escapeLF) where
+module Test.Hspec.Formatters.Codewars (newFormatter, escapeLF) where
 
 import Data.Text (pack, replace, unpack)
 import Text.Printf (printf)
@@ -23,8 +23,8 @@ import Test.Hspec.Core.Formatters.V2 (
 getName :: Path -> String
 getName (_, req) = escapeLF req
 
-codewars :: IO Formatter
-codewars = do
+newFormatter :: IO Formatter
+newFormatter = do
   times <- newIORef ([ ]::[Seconds])
   pure $ silent
     {

test/Main.hs

@@ -3,16 +3,16 @@ module Main (main) where
 import System.Exit
 
 import Test.Hspec.Runner
-import Test.Hspec.Formatters.Codewars (codewars, escapeLF)
+import Test.Hspec.Formatters.Codewars (newFormatter, escapeLF)
 import Test.Hspec.Core.Formatters.V2 (formatterToFormat, formatException)
 import Test.Hspec.Core.Util (safeTry)
 
 import qualified Spec
 
 main :: IO ()
 main = do
-  formatter <- codewars
-  summary <- safeTry $ runSpec Spec.spec defaultConfig {configFormat = Just $ formatterToFormat formatter}
+  codewars <- newFormatter
+  summary <- safeTry $ runSpec Spec.spec defaultConfig {configFormat = Just $ formatterToFormat codewars}
   case summary of
     Left ex -> do
       putStrLn $ "\n<ERROR::>Test suite crashed<:LF:>" ++ (escapeLF $ formatException ex)