tap-out (patched)

Node 14 (or 13 --harmony) is required in this fork

A different tap parser

Install

npm install tap-out --save

Usage

CLI

$ 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

1var tapOut = require('tap-out');
2
3var t = tapOut(function (output) {
4
5  console.log(output);
6});
7
8t.on('assert', function (assert) {
9
10	// Do something
11});
12
13process.stdin.pipe(t);

Methods

var t = tapOut(function (err, output) {})

Returns a stream that emits events with various TAP data. Takes a callback which is called when all parsing is done.

Events

t.on('output', function (output) {})

All output after all TAP data is parsed.

Example output

1{
2  tests: [
3    { name: 'is true', number: 1, raw: '# is true', type: 'test' }
4  ],
5  asserts: [
6    { name: 'true value', number: 1, ok: true, raw: 'ok 1 true value', test: 1, type: 'assert' },
7    { name: 'true value', number: 2, ok: true, raw: 'ok 2 true value', test: 1, type: 'assert' }
8  ],
9  results: [],
10  versions: [],
11  comments: [],
12  fail: [],
13  pass: [
14    { name: 'true value', number: 1, ok: true, raw: 'ok 1 true value', test: 1, type: 'assert' },
15    { name: 'true value', number: 2, ok: true, raw: 'ok 2 true value', test: 1, type: 'assert' }
16  ],
17}

t.on('test', function (test) {})

Parsed test object with details.

• type - value will always be test
• name - name of the test
• raw - the raw output before it was parsed
• number - the number of the test

1{
2  type: 'test',
3  name: 'is true',
4  raw: '# is true',
5  number: 1
6}

t.on('assert', function (assertion) {})

Parsed assert object details.

• type - this will always be assert
• name - the name of the assertion
• raw - the raw output before it was parsed
• number - the number of the assertion
• ok - whether the assertion passed or failed
• test - the number of the test this assertion belongs to

1{
2  name: 'true value',
3  number: 1,
4  ok: true,
5  raw: 'ok 1 true value',
6  test: 1,
7  type: 'assert'
8}

t.on('version', function (version) {})

Parsed version data.

• type - this will always be version
• raw - the raw output before it was parsed

1{
2  raw: 'TAP version 13',
3  type: 'version'
4}

t.on('result', function (result) {})

Parsed test result data for tests, pass, fail.

• type - this will always be result
• name - the name of the result
• raw - the raw output before it was parsed
• count - the number of tests related to this result

Tests

1{
2  count: '15',
3  name: 'tests',
4  raw: '# tests 15',
5  type: 'result'
6}

Pass

1{
2  count: '13',
3  name: 'pass',
4  raw: '# pass  13',
5  type: 'result'
6}

Fail

1{
2  count: '2',
3  name: 'fail',
4  raw: '# fail  2',
5  type: 'result'
6}

t.on('pass', function (assertion) {})

Parsed assertion that has passed with details. The assertion formate is the same as the assert event.

t.on('fail', function (assertion) {})

Failed assertion that has passed with details. The assertion formate is the same as the assert event.

t.on('comment', function (comment) {})

Generic output like console.log() in your tests.

• type - this will always be comment
• raw - the raw output before it was parsed
• test - the number of the test this comment belongs to

1{
2  type: 'comment',
3  raw: 'this is a console log',
4  test: 1
5}

Run Tests

git clone git@github.com:scottcorgan/tap-out.git && cd tap-out
npm install
npm test

Contributions

See our contributing doc, be sure to checkout the code of conduct

Conventional Commits

This project used conventional commits to manage versions and releases of the library therefore when making a commit please use npm commit <COMMIT_PARAMETERS> and this will guide you through writing a conventional commit message which can be understood work with the ci pipeline