log-utils
Tiny wrapper around ansi-colors to add colored symbols and a timestamp.
Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your
Install
Install with npm:
$ npm install --save log-utils
Usage
const log = require('log-utils');
API
.error
Get a red error symbol.
Example
console.log(log.error); //=> ✖
.info
Get a cyan info symbol.
Example
console.log(log.info); //=> ℹ
.success
Get a green success symbol.
Example
console.log(log.success); //=> ✔
.warning
Get a yellow warning symbol.
Example
console.log(log.warning); //=> ⚠
.timestamp
Get a formatted timestamp.
Example
console.log(log.timestamp); //=> [15:27:46]
.ok
Returns a formatted string prefixed by a green check.
Example
console.log(log.ok(' foo'));
console.log(log.ok(' foo'));
console.log(log.ok(' foo'));
console.log(log.ok('foo'));
// Results in:
// ✔ foo
// ✔ foo
// ✔ foo
// ✔ foo
.heading
Make the given text bold and underlined.
Example
console.log(log.heading('foo'));
// or
console.log(log.heading('foo', 'bar'));
Colors
Available colors from ansi-colors:
Changes
v0.2.0 (2016-07-16)
removed
: all spinner methods
v0.1.5 (2016-07-16)
added
:.header
methodfixed
:.ok
method, so that whitespace is respected
About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
Building docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
Related projects
You might also be interested in these projects:
ansi-colors: Easily add ANSI colors to your text and symbols in the terminal. A faster drop-in… more | homepage
Contributors
Commits | Contributor |
---|---|
23 | jonschlinkert |
5 | doowb |
Author
Jon Schlinkert
License
Copyright © 2018, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.8.0, on November 17, 2018.