- Notifications
You must be signed in to change notification settings - Fork28
scottcorgan/tap-out
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
A different tap parser
npm install tap-out --saveCLI
$ something-that-produces-tap | tap-out{ tests: [ { name: 'is true', number: 1, raw: '# is true', type: 'test' } ], asserts: [ { name: 'true value', number: 1, ok: true, raw: 'ok 1 true value', test: 1, type: 'assert' }, { name: 'true value', number: 2, ok: true, raw: 'ok 2 true value', test: 1, type: 'assert' } ], versions: [], results: [], comments: [], plans: [{ type: 'plan', raw: '1..2', from: 1, to: 2, skip: false }], pass: [ { name: 'true value', number: 1, ok: true, raw: 'ok 1 true value', test: 1, type: 'assert' }, { name: 'true value', number: 2, ok: true, raw: 'ok 2 true value', test: 1, type: 'assert' } ], fail: [], errors: []}API
vartapOut=require('tap-out');vart=tapOut(function(output){console.log(output);});t.on('assert',function(assert){// Do something});process.stdin.pipe(t);
Returns a stream that emits events with various TAP data. Takes a callback which is called when all parsing is done.
All output after all TAP data is parsed.
Example output
{tests:[{name:'is true',number:1,raw:'# is true',type:'test'}],asserts:[{name:'true value',number:1,ok:true,raw:'ok 1 true value',test:1,type:'assert'},{name:'true value',number:2,ok:true,raw:'ok 2 true value',test:1,type:'assert'}],results:[],versions:[],comments:[],fail:[],pass:[{name:'true value',number:1,ok:true,raw:'ok 1 true value',test:1,type:'assert'},{name:'true value',number:2,ok:true,raw:'ok 2 true value',test:1,type:'assert'}],}
Parsed test object with details.
type- value will always betestname- name of the testraw- the raw output before it was parsednumber- the number of the test
{type:'test',name:'is true',raw:'# is true',number:1}
Parsed assert object details.
type- this will always beassertname- the name of the assertionraw- the raw output before it was parsednumber- the number of the assertionok- whether the assertion passed or failedtest- the number of the test this assertion belongs to
{name:'true value',number:1,ok:true,raw:'ok 1 true value',test:1,type:'assert'}
Parsed version data.
type- this will always beversionraw- the raw output before it was parsed
{raw:'TAP version 13',type:'version'}
Parsed test result data for tests, pass, fail.
type- this will always beresultname- the name of the resultraw- the raw output before it was parsedcount- the number of tests related to this result
Tests
{count:'15',name:'tests',raw:'# tests 15',type:'result'}
Pass
{count:'13',name:'pass',raw:'# pass 13',type:'result'}
Fail
{count:'2',name:'fail',raw:'# fail 2',type:'result'}
Parsed assertion that has passed with details. The assertion formate is the same as theassert event.
Failed assertion that has passed with details. The assertion formate is the same as theassert event.
Generic output likeconsole.log() in your tests.
type- this will always becommentraw- the raw output before it was parsedtest- the number of the test this comment belongs to
{type:'comment',raw:'this is a console log',test:1}
git clone git@github.com:scottcorgan/tap-out.git && cd tap-outnpm installnpm test