Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joeybaker/tap-simple
Simple tap formatter: does not clutter output with successes and shows a diff of actual vs. expected.
https://github.com/joeybaker/tap-simple
Last synced: 22 days ago
JSON representation
Simple tap formatter: does not clutter output with successes and shows a diff of actual vs. expected.
- Host: GitHub
- URL: https://github.com/joeybaker/tap-simple
- Owner: joeybaker
- License: other
- Created: 2015-04-30T00:39:55.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-04-30T21:11:00.000Z (over 9 years ago)
- Last Synced: 2024-04-26T02:41:18.597Z (7 months ago)
- Language: JavaScript
- Size: 184 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-tap - tap-simple - Simple output. (Reporters / JavaScript)
README
# tap-simple [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-url]][daviddm-image]
Simple tap formatter: does not clutter output with successes and shows a diff of actual vs. expected.
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
- [Install](#install)
- [Usage](#usage)
- [CLI](#cli)
- [Programmatic](#programmatic)
- [Tests](#tests)
- [Developing](#developing)
- [Requirements](#requirements)
- [License](#license)
## Install
```sh
npm i -g tap-simple
```
## Usage
### CLI
```sh
tape test/*test.js | tap-simple
```
### Programmatic
```js
import tapSimple from 'tap-simple'
process.stdin
.pipe(tapSimple())
.pipe(process.stdout)
```
Tap-simple is written in es6. You need to compile it if you're not in an es6 environment.
```js
require('babel/register')
var tapSimple = require('tap-simple')
process.stdin
.pipe(tapSimple())
.pipe(process.stdout)
```
## Tests
Tests are in [tape](https://github.com/substack/tape) and code coverage is run though [covert](https://github.com/substack/covert).
* `npm test` will run the tests.
* `npm run tdd` will run the tests on every file change.
## Developing
To publish, run `npm run release -- [{patch,minor,major}]`
_NOTE: you might need to `sudo ln -s /usr/local/bin/node /usr/bin/node` to ensure node is in your path for the git hooks to work_
### Requirements
* **npm > 2.0.0** So that passing args to a npm script will work. `npm i -g npm`
* **git > 1.8.3** So that `git push --follow-tags` will work. `brew install git`
## License
Artistic 2.0 © [Joey Baker](byjoeybaker.com)
Thanks to [tap-spec](https://github.com/scottcorgan/tap-spec) for the original structure and [tap-difflet](https://github.com/namuol/tap-difflet) for the original diffing algorithm.
[npm-url]: https://npmjs.org/package/tap-simple
[npm-image]: https://badge.fury.io/js/tap-simple.svg
[travis-url]: https://travis-ci.org/joeybaker/tap-simple
[travis-image]: https://travis-ci.org/joeybaker/tap-simple.svg?branch=master
[daviddm-url]: https://david-dm.org/joeybaker/tap-simple.svg?theme=shields.io
[daviddm-image]: https://david-dm.org/joeybaker/tap-simple