json-human-reporter

Converts JSON from Mocha test reporter to human output

Install and use

npm install --save-dev json-human-reporter

Run Mocha with json reporter

mocha --reporter json > results.json

Then transform results.json into human readable output

json-human-reporter results.json

You can even pass multiple filenames and get a combined output. You can also pass --stack true option to print the error stack traces for every failed test.

json-human-reporter --stack true one.json two.json three.json

Why?

Because multiple reporters in Mocha seem a little bit too far in the future, see #2184 and I wanted something now.

Module API

You can just use the conversion from JSON object to human-friendly text

const toHuman = require('json-human-reporter/json-to-human')
const text = toHuman({
  passed: [],
  ...
})

You can pass multiple test results, they will be combined into one

const toHuman = require('json-human-reporter/json-to-human')
const results1 = {
  passed: [],
  ...
}
const results2 = {
  passed: [],
  ...
}
const text = toHuman(results1, results2, ...)

You can pass options object among the test results. The only option supported is "stack" to enable printing error stack in addition to the error message.

const toHuman = require('json-human-reporter/json-to-human')
const results1 = {
  passed: [],
  ...
}
const results2 = {
  passed: [],
  ...
}
const text = toHuman(results1, results2, {stack: true})

Small print

Author: Gleb Bahmutov <gleb.bahmutov@gmail.com> © 2016

• @bahmutov
• glebbahmutov.com
• blog

License: MIT - do anything with the code, but don't blame me if it does not work.

Support: if you find any problems with this module, email / tweet / open issue on Github

MIT License

Copyright (c) 2016 Gleb Bahmutov <gleb.bahmutov@gmail.com>

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.