From d02a238bf0d513887cf455cd60b3ae32d3d0ced7 Mon Sep 17 00:00:00 2001 From: Douglas Brown Date: Fri, 14 Oct 2016 13:27:44 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=92=81=20=20Adjust=20ospec=20bin=20def,?= =?UTF-8?q?=20add=20to=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Getting set up with ospec is deceptively simple, and adding just a bit more documentation should help new users from falling into the trap of overthinking the test config. (I know that I ended up down a very strange rabbit hole when pulling ospec into a project). This also adjusts the bin definition in the package file so that we can hopefully just use the `ospec` command instead of a folder ref. --- ospec/README.md | 38 +++++++++++++++++++++++++++++++++++++- ospec/package.json | 4 +++- 2 files changed, 40 insertions(+), 2 deletions(-) diff --git a/ospec/README.md b/ospec/README.md index 8b160277..143f67f8 100644 --- a/ospec/README.md +++ b/ospec/README.md @@ -4,7 +4,7 @@ Noiseless testing framework -Version: 1.1 +Version: 1.1 License: MIT ## About @@ -259,6 +259,42 @@ _o("a test", function() { _o.run() ``` +### Running the test suite from the command-line + +ospec will automatically evaluate all `*.js` files in any folder named `/tests`. + +`o.run()` is automatically called by the cli - no need to call it in your test code. + +#### Create an npm script in your package: +``` + "scripts": { + ... + "test": "ospec", + ... + } +``` + +``` + $ npm test +``` + +#### (Optionally) Install Globally + +``` + $ npm i -g ospec + $ ospec +``` + +#### (Optionally) Evaluate ES6+ code: + +One way to accomplish this would be to include the 'babel-cli' module (`npm i babel-cli`) + +(This would pre-suppose that you're already using babel in your project and thus have it configured to your liking). + +``` + $ babel-node ospec +``` + --- ## API diff --git a/ospec/package.json b/ospec/package.json index 1143482c..0dd9df2b 100644 --- a/ospec/package.json +++ b/ospec/package.json @@ -9,6 +9,8 @@ "keywords": [ "testing" ], "author": "Leo Horie ", "license": "MIT", - "bin": "./bin/ospec", + "bin": { + "ospec": "./bin/ospec" + }, "repository": "lhorie/mithril.js#rewrite" }