# luvely

> Lovely formatting for bunyan

Latest version **0.10.3** (published 2016-01-08) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install luvely
pnpm add luvely
yarn add luvely
bun add luvely
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.10.3 |
| Published | 2016-01-08 |
| First published | 2014-05-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 4.2.1 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Johnny Ray Austin |
| Maintainers | recursivefunk |
| Keywords | logging, bunyan, formatted, formatting, readable |

## Links

- npm: https://www.npmjs.com/package/luvely
- Repository: https://github.com/recursivefunk/luvely
- Homepage: https://github.com/recursivefunk/luvely#readme
- Issues: https://github.com/recursivefunk/luvely/issues
- npm.io page: https://npm.io/package/luvely

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ^1.1.1
- [event-stream](https://npm.io/package/event-stream.md) ^3.3.2

## Alternatives

- [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads
- [log](https://npm.io/package/log.md) — 1.3M weekly downloads
- [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads
- [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads
- [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads

## Recent versions

- 0.10.3 (latest) — 2016-01-08
- 0.10.2 — 2016-01-07
- 0.10.1 — 2016-01-04
- 0.9.1 — 2016-01-01
- 0.0.5 — 2014-05-21
- 0.0.1 — 2014-05-20

## README

# luvely

A human readable format for bunyan's JSON logging.

### Why?
Bunyan is the best logging solution for node applications. By default, it logs everything in JSON format. It does come with a handy CLI for formatting human readable logs but it's a separate process. Luvely gives you a stream you can use IN ADDITION to your JSON logs. I highly recommend using bunyans JSON formatted logs for machine consumable purposes but machines aren't the ones reading stdout - you are. Use luvely for stdout and JSON everywhere else (files, APIs etc). You get the best of both worlds without having to pipe your process through a script.

### What does it look like?
![example](example.png)

If you enabled the bunyan `src:true` options, you'll get that information for errors and up
![src-example](src-example.png)

### Install
```
$ npm install luvely --save
```

### Quick Start
```javascript
const luvely = require('luvely');
const appName = 'myApp';
const luvelyStream = luvely();

const log = bunyan.createLogger({
  name: appName,
  stream: luvelyStream,
  level: 'trace'
});
```

### Recommended Usage
```javascript
const luvely = require('luvely');  
const appName = 'myApp';

const log = bunyan.createLogger({
  streams: [
    {
      level: 'info',
      stream: luvely() // this will go to stdout for humans      
    },
    {
      level: 'info',
      stream: someFileOrThirdPartyStream() // this will be JSON for machines
    }
  ]
});
```

### Tests
```
$ npm test
```

---
_Source: https://npm.io/package/luvely · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._