prettyoutput [![NPM version][npm-image]][npm-url] [![build status][travis-image]][travis-url] [![Test coverage][coveralls-image]][coveralls-url]

Library to format js/json object into YAML style readable output.
It's performance centric to be used as a logger formatter.
It's currently 3 to 5 times quicker than util.inspect used by many loggers.
It's available as a NodeJS library or a cli too.

Credits

This is based on the great work done on the project prettyjson

How to install

Via NPM:

``bash $ npm install prettyoutput`

`Using it`

It's pretty easy to use. Just have include it in your script and call it:

`javascript const prettyoutput = require('prettyoutput')

const data = { username: 'kic', url: 'https://github.com/keepitcool', projects: ['prettyoutput', '3m2tuio'] }

console.log(prettyoutput(data))`

Output:

!Example

`$3`

`javascript const prettyoutput = require('prettyoutput') prettyoutput(data, options, indent)`

Parameters are : {} data : js or json object * {Object} [options] : Optional. See options below * {number} [indent] : Optional. Indent all output

Options are : * {number} [indentationLength] : Length of indentation (in terms of space) * {number} [maxDepth] : maximum sublevel of nested objects/arrays to output. Default: 3 * {boolean} [noColor] : disable colors. Default: false * {colors} [colors] : Output colors. See below * {boolean} [alignKeyValues] : Align key values. Default: true

Colors are : * {string} [keys] : Objects keys color. Default: green * {string} [dash] : Array prefixing dash ("- "). Default: green * {string} [number] : Numbers color. Default: blue * {string} [string] : Strings color. Default: no color * {string} [true] : Boolean value 'true' color. Default: green * {string} [false] : Boolean value 'false' color. Default: red * {string} [null] : 'Null' color. Default: grey * {string} [undefined] : 'Undefined' color. Default: grey

Example using options :`javascript const prettyoutput = require('prettyoutput')

const data = { username: 'kic', url: 'https://github.com/keepitcool', projects: ['prettyoutput', '3m2tuio'] }

const colors = { keys: 'blue', 'null': 'red' }

const options = { noColor: true, maxDepth: 5, colors: colors };

console.log(prettyoutput(data, options, 2);`

`Cli usage`

Command line tool support file param or stdin.

Usage:`bash $ prettyoutput package.json`

This should output : !Example

`$3`

It's possible to customize the output through some command line options:

`bash

`Indent 4, max depth 5, disable colors`


$ prettyjson --indent=4 --depth=5 --noColor package.json

or

`bash

`Indent 4, max depth 5, disable colors`


$ cat package.json | prettyjson --indent=4 --depth=5 --noColor


Benchmark

Project target logging, so performance is an issue.
Currently, prettyoutput is 3 times quicker than util.inspect and 2.5 times quicker than prettyjson, the library it's inspired from.

To run benchmark, just run :`bash $ node benchmark/benchmark.js`

`Running Tests`

To run the test suite first invoke the following command within the repo, installing the development dependencies:

`bash $ npm install`

then run the tests:

`bash $ npm test``

[npm-image]: https://img.shields.io/npm/v/prettyoutput.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/prettyoutput
[travis-image]: https://img.shields.io/travis/keepitcool/prettyoutput/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/keepitcool/prettyoutput
[coveralls-image]: https://img.shields.io/codecov/c/github/keepitcool/prettyoutput.svg?style=flat-square
[coveralls-url]: https://codecov.io/github/keepitcool/prettyoutput?branch=master

prettyoutput [![NPM version][npm-image]][npm-url] [![build status][travis-image]][travis-url] [![Test coverage][coveralls-image]][coveralls-url]

Credits

This is based on the great work done on the project prettyjson

How to install

Via NPM:

``bash $ npm install prettyoutput`

`Using it`

It's pretty easy to use. Just have include it in your script and call it:

`javascript const prettyoutput = require('prettyoutput')

const data = { username: 'kic', url: 'https://github.com/keepitcool', projects: ['prettyoutput', '3m2tuio'] }

console.log(prettyoutput(data))`

Output:

!Example

`$3`

`javascript const prettyoutput = require('prettyoutput') prettyoutput(data, options, indent)`

Parameters are : {} data : js or json object * {Object} [options] : Optional. See options below * {number} [indent] : Optional. Indent all output

Example using options :`javascript const prettyoutput = require('prettyoutput')

const data = { username: 'kic', url: 'https://github.com/keepitcool', projects: ['prettyoutput', '3m2tuio'] }

const colors = { keys: 'blue', 'null': 'red' }

const options = { noColor: true, maxDepth: 5, colors: colors };

console.log(prettyoutput(data, options, 2);`

`Cli usage`

Command line tool support file param or stdin.

Usage:`bash $ prettyoutput package.json`

This should output : !Example

`$3`

It's possible to customize the output through some command line options:

`bash

`Indent 4, max depth 5, disable colors`


$ prettyjson --indent=4 --depth=5 --noColor package.json

or

`bash

`Indent 4, max depth 5, disable colors`


$ cat package.json | prettyjson --indent=4 --depth=5 --noColor


Benchmark

Project target logging, so performance is an issue.
Currently, prettyoutput is 3 times quicker than util.inspect and 2.5 times quicker than prettyjson, the library it's inspired from.

To run benchmark, just run :`bash $ node benchmark/benchmark.js`

`Running Tests`

To run the test suite first invoke the following command within the repo, installing the development dependencies:

`bash $ npm install`

then run the tests:

`bash $ npm test``