tap-reader
v0.2.1
Published
A smol, streaming TAP parser.
Downloads
4,623
Readme
Sample reporter that leverages tap-reader
:
#!/usr/bin/env node
import { stdin } from 'node:process';
import TapReader from 'tap-reader'
const write = console.log
const reader = TapReader({ input: stdin });
reader.on('version', ({ version }) => {
write('VERSION', version);
});
reader.on('pass', ({ id, desc, skip, todo }) => {
write('PASS', id, desc, todo ? 'TODO' : skip ? 'SKIP' : '');
});
reader.on('fail', ({ id, desc, skip, todo, diag }) => {
write('FAIL', id, desc, todo ? 'TODO' : skip ? 'SKIP' : '');
for (const key in diag)
write(` ${key}: ${diag[key]}`);
});
reader.on('plan', ({ plan, comment, todo }) => {
write(`plan: ${plan[0]} → ${plan[1]} ${comment || ''} ${todo ? 'TODO' :''}`);
})
reader.on('comment', ({ comment, todo, skip }) => {
write('COMMENT', comment, todo ? 'TODO' : skip ? 'SKIP' : '');
})
reader.on('other', ({ line }) => {
if (line.trim().length > 0) write('OTHER', line);
})
reader.on('done', ({ summary, ok }) => {
const { total, pass, fail, skip, todo } = summary;
write('DONE')
write(`total: ${total}`)
write(`pass: ${pass}`)
write(`fail: ${fail}`)
write(`skip: ${skip}`)
write(`todo: ${todo}`)
write(`OK ${ok}`)
})
reader.on('end', ({ ok }) => {
process.exit(ok ? 0 : 1);
})
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.