smartlog-destination-local/README.md

68 lines
2.7 KiB
Markdown
Raw Normal View History

2015-09-20 15:42:50 +00:00
# beautylog
2016-05-03 21:09:57 +00:00
beautiful logging, TypeScript ready
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-05-03 21:09:57 +00:00
[![codecov](https://codecov.io/gh/pushrocks/beautylog/branch/master/graph/badge.svg)](https://codecov.io/gh/pushrocks/beautylog)
2015-09-27 15:23:32 +00:00
## Usage
2015-11-16 22:32:40 +00:00
2016-05-03 21:09:57 +00:00
```javascript
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 ... */
2015-09-27 15:23:32 +00:00
```
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.
2016-05-03 21:09:57 +00:00
> **Note:** This only works only in nodejs for now.
2015-12-20 22:14:22 +00:00
There are different types of tables.
#### Custom
```javascript
2016-05-03 21:09:57 +00:00
var beautylog = require("beautylog");
var myTable = beautylog.table.new("custom",["Heading1".blue,"Heading2".blue,"Heading3".blue]); // type "custom"
2015-12-20 22:14:22 +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
```
#### Checks
2015-11-16 22:32:40 +00:00
```javascript
2016-05-03 21:09:57 +00:00
var beautylog = require("beautylog");
var myTable = beautylog.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)