Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cfware/tap-yaml-summary

Output a summary in YAML format from a TAP stream
https://github.com/cfware/tap-yaml-summary

Last synced: 29 days ago
JSON representation

Output a summary in YAML format from a TAP stream

Awesome Lists containing this project

README

        

# tap-yaml-summary [![NPM Version][npm-image]][npm-url]

Output a summary in YAML format from a TAP stream

## Target User

This produces intentionally bare bones summaries. The primary target is modules
with stable testing. If you are looking for a pretty output look elsewhere.

## Command-line usage

```sh
tap test/*.js | tap-yaml-summary
```

## API

This module works as a transform stream

```js
const Reporter = require('tap-yaml-summary');

fs.createReadStream('saved-test-output.tap')
.pipe(new Reporter().on('error', () => process.exit(1)))
.pipe(process.stdout);
```

The `error` event is emitted on completion if any assertion failed or a bailout occurred.

## Attribution

This was based on `tap-mocha-reporter`.

[npm-image]: https://img.shields.io/npm/v/tap-yaml-summary.svg
[npm-url]: https://npmjs.org/package/tap-yaml-summary