diff --git a/README.md b/README.md index 5570df6..5f5494a 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ **Test.it** is a small testing library for people that want to live in code, not in tests. No over engineering here. Inspired by the simplicity of libraries like [Tape](https://github.com/substack/tape),but the implementation ideas of things like [Expect](https://github.com/Automattic/expect.js) and [TinyTest](https://github.com/joewalnes/jstinytest) -This is probally not a *cure-all* testing solution, if you want something more robust checkout [Jasmine](), [Tape]() or [Mocha]() -- this is to... +This is probally not a *cure-all* testing solution, if you want something more robust checkout [Jasmine](), [Tape]() or [Mocha]() -- this is to... **Test small things, with small things** @@ -17,7 +17,7 @@ This is probally not a *cure-all* testing solution, if you want something more r - No Dependicies - 2kb footprint (*before gzip*) - Extend with custom reporters -- Has an Expect-like style BDD assertions +- Has an Expect-like style BDD assertions **No Bloat Here!** @@ -42,19 +42,20 @@ test.it({ by default, your test results are logged to the console ``` -+ my passing test -- my failing test -- - Error: just wanted to fail fast ++OK my passing test +-ERR my failing test +--- +Error: just wanted to fail fast ...error stack... +--- + # tests 2 pass 1 fail 1 ``` -A `+` will proceed test lines that *pass* and a `-` for those that *fail*, the trace back `file:line` is included after the failing test proceeded by `- -` +A `+OK` will proceed test lines that *pass* and a `-ERR` for those that *fail*, the error stack is included after the failing test wrapped in `---` You can, however, write your own custom test runner... -> NOTE: API still in flux, and may change to closer match TAP - ### Custom Test Runners `test.it` `.run()` method provides an optional `next` function parameter that passes the results as an `object` for you to process *however* you like. @@ -92,10 +93,10 @@ A sample test runner is provided for both **HTML** and **NODE** in the `test/` d ## Methods -To stay minimal, `test.it` only has 3 core functions: +To stay minimal, `test.it` only has 3 core functions: - `it` to capture your tests - `run` to execute yours tests -- and `expects` to write your test assertions +- and `expects` to write your assertions While you can use your own assertion library, the included `expects` provides the following methods for writing your tests: @@ -136,7 +137,7 @@ Please open [an issue](https://github.com/n2geoff/testit/issues/new) for support ## Contributing -Anyone is welcome to contribute, however, if you decide to get involved, please take a moment to review the [guidelines](CONTRIBUTING.md), there minimalistic;) +Anyone is welcome to contribute, however, if you decide to get involved, please take a moment to review the [guidelines](CONTRIBUTING.md), they're minimalistic;) ## License diff --git a/dist/testit.js b/dist/testit.js index 0cf1734..bbd3a87 100644 --- a/dist/testit.js +++ b/dist/testit.js @@ -1,4 +1,4 @@ -/*! Test.it v 0.7.1 | MIT | https://github.com/n2geoff/testit */ +/*! Test.it v 0.8.0 | MIT | https://github.com/n2geoff/testit */ (function (root, factory) { "use strict"; if (typeof module === "object" && module.exports) { @@ -22,10 +22,9 @@ try { test(); - passed.push(`\n+ ${name}`); + passed.push(`\n+OK ${name}`); } catch (err) { - failed.push(`\n- ${name}`); - console.error(err); + failed.push(`\n-ERR ${name} \n --- \n ${err.stack} \n ---`); } }); diff --git a/dist/testit.min.js b/dist/testit.min.js index 9a829c4..1735f54 100644 --- a/dist/testit.min.js +++ b/dist/testit.min.js @@ -1,2 +1 @@ -/*! Test.it v 0.7.1 | MIT | https://github.com/n2geoff/testit */ -!function(t,e){"use strict";"object"==typeof module&&module.exports?module.exports=e(t.test):t.test=e(t.test)}(this,function(){"use strict";const t={_tests:{},run:function(t){let e=this._tests,r=[],o=[];return Object.keys(e).forEach(t=>{let n=e[t];try{n(),o.push(`\n+ ${t}`)}catch(e){r.push(`\n- ${t}`),console.error(e)}}),"function"==typeof t?t({pass:o,fail:r}):(console.log(...o,...r),console.log(`\n# tests ${r.length+o.length} pass ${o.length} fail ${r.length}`),!r.length)},it:function(t){return this._tests=t,this},expects:function(e){return{to:{be:{a:r=>t.expects(e).to.be.an(r),an:t=>{if(-1!==["array"].indexOf(t)){if("array"!==e.constructor.name.toLowerCase())throw new Error(`expected ${typeof e} to be an ${t}`);return!0}if(typeof e!==t)throw new Error(`expected ${typeof e} to be an ${t}`)},like:t=>{if(e!=t)throw new Error(`expected ${e} == ${t}`)}},equal:t=>{if(e!==t)throw new Error(`expected ${e} === ${t}`)},exist:()=>{if(!e)throw new Error(`expected ${e} to be truthy`)},pass:()=>!0,fail:t=>{throw new Error(t)}}}}};return t}); \ No newline at end of file +!function(t,e){"use strict";"object"==typeof module&&module.exports?module.exports=e(t.test):t.test=e(t.test)}(this,function(){"use strict";const t={_tests:{},run:function(t){let e=this._tests,r=[],o=[];return Object.keys(e).forEach(t=>{let n=e[t];try{n(),o.push(`\n+OK ${t}`)}catch(e){r.push(`\n-ERR ${t} \n --- \n ${e.stack} \n ---`)}}),"function"==typeof t?t({pass:o,fail:r}):(console.log(...o,...r),console.log(`\n# tests ${r.length+o.length} pass ${o.length} fail ${r.length}`),!r.length)},it:function(t){return this._tests=t,this},expects:function(e){return{to:{be:{a:r=>t.expects(e).to.be.an(r),an:t=>{if(-1!==["array"].indexOf(t)){if("array"!==e.constructor.name.toLowerCase())throw new Error(`expected ${typeof e} to be an ${t}`);return!0}if(typeof e!==t)throw new Error(`expected ${typeof e} to be an ${t}`)},like:t=>{if(e!=t)throw new Error(`expected ${e} == ${t}`)}},equal:t=>{if(e!==t)throw new Error(`expected ${e} === ${t}`)},exist:()=>{if(!e)throw new Error(`expected ${e} to be truthy`)},pass:()=>!0,fail:t=>{throw new Error(t)}}}}};return t}); \ No newline at end of file diff --git a/package.json b/package.json index 2c70847..37e7360 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "testit", - "version": "0.7.1", + "version": "0.8.0", "description": "a minimalistic testing library", "main": "src/testit.js", "directories": { diff --git a/src/testit.js b/src/testit.js index 10041fa..fa87ba6 100644 --- a/src/testit.js +++ b/src/testit.js @@ -1,4 +1,4 @@ -/*! Test.it v 0.7.1 | MIT | https://github.com/n2geoff/testit */ +/*! Test.it v 0.8.0 | MIT | https://github.com/n2geoff/testit */ (function (root, factory) { "use strict"; // support browser & commonjs @@ -26,10 +26,9 @@ // execute try { test(); - passed.push(`\n+ ${name}`); + passed.push(`\n+OK ${name}`); } catch (err) { - failed.push(`\n- ${name}`); - console.error(err); + failed.push(`\n-ERR ${name} \n --- \n ${err.stack} \n ---`); } });