tap-reader 📜

A smol, streaming TAP parser. Works well with tape.
tap-reader on npmjs.org »
Documentation soon...

Sample reporter that leverages tap-reader:

1#!/usr/bin/env node
2import { stdin } from 'node:process';
3import TapReader from 'tap-reader'
4
5const write = console.log
6const reader = TapReader({ input: stdin });
7
8reader.on('version', ({ version }) => {
9  write('VERSION', version);
10});
11
12reader.on('pass', ({ id, desc, skip, todo }) => {
13  write('PASS', id, desc, todo ? 'TODO' : skip ? 'SKIP' : '');
14});
15
16reader.on('fail', ({ id, desc, skip, todo, diag }) => {
17  write('FAIL', id, desc, todo ? 'TODO' : skip ? 'SKIP' : '');
18  
19  for (const key in diag)
20    write(`  ${key}: ${diag[key]}`);
21});
22
23reader.on('plan', ({ plan, comment, todo }) => {
24  write(`plan: ${plan[0]} → ${plan[1]} ${comment || ''} ${todo ? 'TODO' :''}`);
25})
26
27reader.on('comment', ({ comment, todo, skip }) => {
28  write('COMMENT', comment, todo ? 'TODO' : skip ? 'SKIP' : '');
29})
30
31reader.on('other', ({ line }) => {
32  if (line.trim().length > 0) write('OTHER', line);
33})
34
35reader.on('done', ({ summary, ok }) => {
36  const { total, pass, fail, skip, todo } = summary;
37
38  write('DONE')
39  write(`total: ${total}`)
40  write(`pass: ${pass}`)
41  write(`fail: ${fail}`)
42  write(`skip: ${skip}`)
43  write(`todo: ${todo}`)
44  write(`OK ${ok}`)
45})
46
47reader.on('end', ({ ok }) => {
48  process.exit(ok ? 0 : 1);
49})

Also see examples/table-reporter.js for another example.

Coming next:

• More TAP features like subtests, +pragmas, etc.
• Documentation for config and events
• Intellisense via .d.ts

FAQ:

Why is yaml vendored?
Because the published module is large. tap-reader should install and run as quickly as possible in a CI environment.
I'm not stoked on it so this may change in the future.

Why not use tap-parser?
tap-parser is great but... see above.