smartlog-destination-local/README.md

64 lines
2.5 KiB
Markdown
Raw Normal View History

2015-09-20 15:42:50 +00:00
# beautylog
beautiful logging
2015-09-27 15:16:43 +00:00
2015-11-23 22:54:14 +00:00
## Status
2015-09-27 15:16:43 +00:00
[![Build Status](https://travis-ci.org/pushrocks/beautylog.svg?branch=v0.0.9)](https://travis-ci.org/pushrocks/beautylog)
[![Dependency Status](https://david-dm.org/pushrocks/beautylog.svg)](https://david-dm.org/pushrocks/beautylog)
2015-11-23 22:54:14 +00:00
[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/beautylog/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/beautylog/master/dependencies/npm)
[![bitHound Score](https://www.bithound.io/github/pushrocks/beautylog/badges/score.svg)](https://www.bithound.io/github/pushrocks/beautylog)
2016-02-11 03:04:49 +00:00
[![Coverage Status](https://coveralls.io/repos/github/pushrocks/beautylog/badge.svg?branch=greenkeeper-npmts-2.1.10)](https://coveralls.io/github/pushrocks/beautylog?branch=greenkeeper-npmts-2.1.10)
2015-09-27 15:23:32 +00:00
## Usage
```javascript
2015-11-16 22:32:40 +00:00
### Simple Logging
2015-12-26 00:51:04 +00:00
var bl = require('beautylog'); //for use in OS console environment AND browser console
2015-11-16 22:32:40 +00:00
2015-09-27 15:23:32 +00:00
bl.log('some log message'); //normal console log message
bl.success('some success message'); //success console log message
bl.error('some error message'); //error console log message
//alternatively you can use a logType parameter
bl.log('some log message','normal');
bl.log('some success message','success');
bl.log('some error message','error');
```
2015-11-16 22:32:40 +00:00
The plugin produces beautiful output like this:
2015-09-30 15:27:01 +00:00
![console.png](https://mediaserve.lossless.digital/github.com/pushrocks/beautylog/console.png)
2015-11-16 22:32:40 +00:00
2016-01-30 05:19:44 +00:00
### Code Highlighting
2015-11-16 22:32:40 +00:00
### Console Tables
beautylog allows displaying data in nice tables for better overview.
2015-12-20 22:14:22 +00:00
There are different types of tables.
#### Custom
```javascript
var bl = require('beautylog')("os"); //for use in OS console environment
var myTable = bl.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
2015-11-16 22:32:40 +00:00
```javascript
var bl = require('beautylog')("os"); //for use in OS console environment
2015-12-20 22:14:22 +00:00
var myTable = bl.table.new("checks"); // type checks
2015-11-16 22:32:40 +00:00
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
```
2015-11-16 22:41:50 +00:00
2015-12-20 22:14:22 +00:00
The table from the code with type "checks" above looks like this:
2016-01-30 05:19:44 +00:00
![table.png](https://mediaserve.lossless.digital/github.com/pushrocks/beautylog/table.png)