Add trivial entrypoint + update docs

Author: fsoikin

Diff for: CHANGELOG.md

@@ -5,17 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## v8.4.0
 
-@srghma Use `spec-node` in tests
+## Added
+
+- Use `spec-node` in tests by @srghma
+- New trivial entrypoint function `discoverAndRunSpecs` for ergonomics by @fsoikin
 
 ## v8.0.1
 
-- @CarstenKoenig Fix discovery on Windows by prepending `file://`
+## Changed
+
+- Fix discovery on Windows by prepending `file://` by @CarstenKoenig
 
 ## v8.0.0
-Features:
-- Update to v0.15.0 and support es modules
 
-Breaking changes:
-- `discover` now needs `MonadAff` constraint instead of `MonadEffect` due to dynamic imports returning promises
+## Changed
+- Update to v0.15.0 and support es modules
+- **breaking** `discover` now needs `MonadAff` constraint instead of `MonadEffect` due to dynamic imports returning promises

Diff for: README.md

@@ -4,14 +4,35 @@ purescript-spec-discovery is an extension to
 [purescript-spec](https://github.com/purescript-spec/purescript-spec) that finds
 specs automatically, given a regular expression pattern.
 
-It only works for NodeJS environments, currently.
+It only works for NodeJS environments, currently, since it's using NodeJS
+facilities to list and load modules.
 
 ## Usage
 
+Install via Spago:
+
 ```bash
 spago install spec-discovery
 ```
 
+Use as main entry point:
+
+```purescript
+module Test.Main where
+
+import Prelude
+import Effect (Effect)
+import Test.Spec.Discovery (discoverAndRunSpec)
+import Test.Spec.Reporter.Console (consoleReporter)
+
+main :: Effect Unit
+main = discoverAndRunSpecs [consoleReporter] """My\.Package\..*Spec"""
+```
+
+Or, if you need more sophistication, like an alternative config or whatnot, use
+the `discover` function to just return a list of specs and then run them in
+whatever way you need:
+
 ```purescript
 module Test.Main where
 
@@ -20,21 +41,23 @@ import Effect (Effect)
 import Effect.Aff (launchAff_)
 import Test.Spec.Discovery (discover)
 import Test.Spec.Reporter.Console (consoleReporter)
-import Test.Spec.Runner (runSpec)
+import Test.Spec.Runner.Node (runSpecAndExitProcess)
+import Test.Spec.Runner.Node.Config (defaultConfig)
 
 main :: Effect Unit
 main = launchAff_ do
   specs <- discover """My\.Package\..*Spec"""
-  runSpec [consoleReporter] specs
+  liftEffect $ runSpecAndExitProcess'
+    { defaultConfig: defaultConfig { timeout = Nothing }
+    , parseCLIOptions: true
+    }
+    [consoleReporter]
+    specs
 ```
 
 All modules that match the regular expression, **and have a definition
 `spec :: Spec Unit`**, will be included and run.
 
-## Documentation
-
-Documentation is publised on [Pursuit](https://pursuit.purescript.org/packages/purescript-spec-discovery).
-
 ## Contribute
 
 If you have any issues or possible improvements please file them as

Diff for: spago.yaml

@@ -6,7 +6,7 @@ package:
   name: spec-discovery
   publish:
     license: MPL-2.0
-    version: 8.3.0
+    version: 8.4.0
     location:
       githubOwner: purescript-spec
       githubRepo: purescript-spec-discovery

Diff for: src/Test/Spec/Discovery.purs

@@ -1,21 +1,28 @@
-module Test.Spec.Discovery (discover) where
+module Test.Spec.Discovery
+  ( discover
+  , discoverAndRunSpecs
+  )
+  where
 
 import Prelude
 
 import Control.Promise (Promise)
 import Control.Promise as Promise
 import Data.Traversable (sequence_)
 import Effect (Effect)
+import Effect.Aff (launchAff_)
 import Effect.Aff.Class (class MonadAff, liftAff)
+import Effect.Class (liftEffect)
 import Test.Spec (Spec)
+import Test.Spec.Runner (Reporter)
+import Test.Spec.Runner.Node (runSpecAndExitProcess)
 
-foreign import getSpecs
-  :: String
-  -> Effect (Promise (Array (Spec Unit)))
+foreign import getSpecs :: String -> Effect (Promise (Array (Spec Unit)))
 
-discover
-  :: forall m
-   . MonadAff m
-  => String
-  -> m (Spec Unit)
+discover :: ∀ m. MonadAff m => String -> m (Spec Unit)
 discover pattern = getSpecs pattern # Promise.toAffE >>= (pure <<< sequence_) # liftAff
+
+discoverAndRunSpecs :: Array Reporter -> String -> Effect Unit
+discoverAndRunSpecs reporters pattern = launchAff_ do
+  specs <- discover pattern
+  liftEffect $ runSpecAndExitProcess reporters specs

Diff for: test/Main.purs

@@ -3,11 +3,8 @@ module Test.Main where
 import Prelude
 
 import Effect (Effect)
-import Effect.Aff (launchAff_)
-import Effect.Class (liftEffect)
-import Test.Spec.Discovery (discover)
+import Test.Spec.Discovery (discoverAndRunSpecs)
 import Test.Spec.Reporter.Console (consoleReporter)
-import Test.Spec.Runner.Node (runSpecAndExitProcess)
 
 main :: Effect Unit
-main = launchAff_ $ discover "Test\\.Spec\\.Discovery.*Spec" >>= (liftEffect <<< runSpecAndExitProcess [consoleReporter])
+main = discoverAndRunSpecs [consoleReporter] "Test\\.Spec\\.Discovery.*Spec"