a smartlog destination targeting the local console
Go to file
2016-05-19 19:45:39 +02:00
dist fix function call issue 2016-05-19 19:45:31 +02:00
test normal log function now respects an active Ora. 2016-05-17 00:24:56 +02:00
ts fix function call issue 2016-05-19 19:45:31 +02:00
.bithoundrc small fix for better pipelog support 2015-12-02 16:23:39 +01:00
.gitignore cleanup 2016-04-04 22:37:47 +02:00
.npmignore update git ignore 2016-04-04 22:52:05 +02:00
.travis.yml update .travis.yml 2016-05-19 19:30:38 +02:00
appveyor.yml Create appveyor.yml 2016-05-19 06:31:34 +02:00
code.css add code function 2016-01-30 06:19:44 +01:00
LICENSE Initial commit 2015-09-20 17:42:50 +02:00
npmts.json update smartenv dependency 2016-02-20 10:29:35 +01:00
package.json 5.0.4 2016-05-19 19:45:39 +02:00
README.md Update README.md 2016-05-19 06:53:51 +02:00

beautylog

beautiful logging, TypeScript ready

Status

Build Status Build status Dependency Status bitHound Dependencies bitHound Score codecov

Usage

var beautylog = require("beautylog"); //for use in OS console environment AND browser console

beautylog.log("some log message"); // normal console log message
beautylog.info("some log message") // info console log message
beautylog.ok("some log message"); // ok console log message
beautylog.warn("some log message"); // warn console log message
beautylog.success("some success message"); // success console log message
beautylog.error("some error message"); // error console log message

// alternatively you can use a logType parameter
beautylog.log("some log message","normal");
beautylog.log("some success message","success");
beautylog.log("some error message","error");
/* ... and so on ... */

The plugin produces beautiful output like this: console.png

Ora Integration

beautylog wraps the excellent ora module from npm to better work with beautylog. In general that means that you can log persistent messages WHILE you are actually having an active Ora object. beautylog handles all the fuss for you.

var myOra = new beautylog.Ora("my awesome text", "blue");
myOra.start();
beautylog.info("some persistent text") //does not disturb myOra
myOra.text("some updated text");
myOra.stop();

Console Tables

beautylog allows displaying data in nice tables for better overview.

Note: This only works only in nodejs for now.

There are different types of tables.

Custom

var beautylog = require("beautylog");
var myTable = beautylog.table.new("custom",["Heading1".blue,"Heading2".blue,"Heading3".blue]); // type "custom"
myTable.push(["check 1","success"]); // adds a row the myTable
myTable.push(["check 2","error"]); // adds a row the myTable
myTable.push(["check 3","error"]); // adds a row the myTable
myTable.print(); //prints myTable to the console

Checks

var beautylog = require("beautylog");
var myTable = beautylog.table.new("checks"); // type checks
myTable.push(["check 1","success"]); // adds a row the myTable
myTable.push(["check 2","error"]); // adds a row the myTable
myTable.push(["check 3","error"]); // adds a row the myTable
myTable.print(); //prints myTable to the console

The table from the code with type "checks" above looks like this: table.png

About the authors:

Project Phase

PayPal