Consume TAP, produce markdown.
JavaScript
Clone or download
Latest commit ba05a9e Jun 15, 2016
Permalink
Failed to load latest commit information.
bin Merged zoubin-refactor Jun 14, 2016
test Merged zoubin-refactor Jun 14, 2016
.gitignore Initial commit Jun 1, 2016
.travis.yml Merged zoubin-refactor Jun 14, 2016
CHANGELOG.md 1.2.1 Jun 15, 2016
README.md Add example to readme Jun 14, 2016
index.js Merged zoubin-refactor Jun 14, 2016
package.json 1.2.1 Jun 15, 2016

README.md

tap-markdown

Consume TAP, produce markdown.

version status dependencies devDependencies

Install

npm install tap-markdown -g

Usage

tape test/*.js | tap-markdown

or in package.json

{
  "scripts": {
    "test": "tape test/*.js | tap-markdown"
  }
}

Example output

# Tests

- ✔ t.plan [pass: 1, fail: 0, duration: 0ms]
- ✔ t.end [pass: 2, fail: 0, duration: 3ms]

# Summary

- duration: 3ms
- planned: 3
- assertions: 3
- pass: 3
- fail: 0

CLI Options

  --no-tidy        Disable tidy-markdown

Acknowledgments

This TAP consumer is a thin wrapper around zoubin/tap-summary and tidy-markdown. The only difference at the moment is this consumer defaults to no-ansi, no-progress, and tidy markdown output. This is ideal for sending test results to a markdown file.

License

MIT License

Copyright (c) 2016 Jayson Harshbarger

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.