Skip to content

Commit

Permalink
Adds screenshots in README
Browse files Browse the repository at this point in the history
  • Loading branch information
olih committed Apr 8, 2016
1 parent f86798d commit d4f5f0a
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 8 deletions.
28 changes: 23 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# solace [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage percentage][coveralls-image]][coveralls-url]
> Alternative to the console log which automatically beautifies the output
Solace is particularly useful if you intend:
* to debug some data.
* to display some data for a CLI.

Solace has a specific support for string, boolean, number, date, regex, null, void, error, NaN, object, array and will deal with these types in a pleasant way.

By default, the output is expected to be stdout/stderr, but you can override this to implement more advanced logging.

The theme (machine, beautiful, outline) can be changed at runtime, which can be a handy option for the user of a CLI.

## Installation

```sh
Expand All @@ -13,9 +23,9 @@ $ npm install --save solace
import solaceCreator from 'solace';

const solace = solaceCreator({
standardOut: process.stdout,
standardErr: process.stderr,
defaultTheme: 'beautiful'
//standardOut: process.stdout,
//standardErr: process.stderr,
//defaultTheme: 'beautiful'
});

const value = {
Expand All @@ -34,7 +44,15 @@ solace.log(value, {title: 'title', theme: 'outline'});

* machine: Format the output in a compact manner easily readable by a machine.
* beautiful: Format the output in a beautiful manner.
* outline: Format the output with the main outlines.
* outline: Format the output with the main outlines. If the data is an array of objects, it may be displayed as a table.

Example of beautiful output:

![Beautiful theme](/screenshots/solace-beautiful.png)

Example of outline output:

![Outline theme](/screenshots/solace-outline.png)


## License
Expand All @@ -48,5 +66,5 @@ MIT © [flarebyte](https://github.com/flarebyte)
[travis-url]: https://travis-ci.org/flarebyte/solace
[daviddm-image]: https://david-dm.org/flarebyte/solace.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/flarebyte/solace
[coveralls-image]: https://coveralls.io/repos/flarebyte/solace/badge.svg?branch=master&service=githubs
[coveralls-image]: https://coveralls.io/repos/github/flarebyte/solace/badge.svg?branch=master
[coveralls-url]: https://coveralls.io/github/flarebyte/solace?branch=master
4 changes: 2 additions & 2 deletions lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ const isArrayOfSimpleObjects = (values) => {

export default (cfg) => {
Joi.assert(cfg, confSchema);
const stdOut = cfg.standardOut;
const stdErr = cfg.standardErr;
const stdOut = cfg.standardOut ? cfg.standardOut : process.stdout;
const stdErr = cfg.standardErr ? cfg.standardErr : process.stderr;
const themes = {
machine: machine,
beautiful: beautiful,
Expand Down
6 changes: 5 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@
"stdout",
"beautify",
"json",
"yaml"
"yaml",
"CLI",
"command line interface",
"debugging",
"logging"
],
"repository": "https://github.com/flarebyte/solace.git",
"devDependencies": {
Expand Down
Binary file added screenshots/solace-beautiful.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/solace-outline.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d4f5f0a

Please sign in to comment.