simple-output

3.0.0 • Public • Published

simple-output

NPM version Build Status License

Pretty output messages to stdout/stderr with no extra dependencies.



render examples

Getting Started

Install the module with: npm install simple-output

Examples

var log = require('simple-output');

log.success('Successful hello world');

Available methods

  • success(msg)
  • info(msg)
  • warn(msg)
  • error(msg)
  • node(msg) prints a green hexagon icon (on supported platforms) along with msg
  • message(msg) prints msg, no icon associated with it
  • hint(msg) useful if you want to dim some of the output

Testing

This module helps on testing your output data by making it simpler to mock simple-output and its methods or use the exposed streams interface to which the data gets written to.

In order to test your output information, replace the stdout/stderr properties with an mock object containing a write function (simulating the streams api). See the example below:

Mock simpleOutput.stdout

var log = require('simple-output');
var myModule = require('../my-module');

log.stdout = {
    write: function(msg) {
        assert(msg, 'hello world');
    }
};

myModule.methodThatUsesSimpleLogInfoInternally();

Using a mocking library

var requireInject = require('require-inject');

var myModule = requireInject('../my-module', {
    'simple-output': {
        info: msg => assert(msg, 'hello world');
    }
});

myModule.methodThatUsesSimpleLogInfoInternally();

License

MIT © 2022 Ruy Adorno

Package Sidebar

Install

npm i simple-output

Weekly Downloads

3,354

Version

3.0.0

License

MIT

Unpacked Size

5.79 kB

Total Files

4

Last publish

Collaborators

  • ruyadorno