# winston-format-console-ootb

> Winston formatter for console output out-of-the-box.

Latest version **1.0.0** (published 2021-01-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install winston-format-console-ootb
pnpm add winston-format-console-ootb
yarn add winston-format-console-ootb
bun add winston-format-console-ootb
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2021-01-18 |
| First published | 2021-01-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 11.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | KOMIYA Atsushi |
| Maintainers | komiya-atsushi |
| Keywords | logger, winston |

## Links

- npm: https://www.npmjs.com/package/winston-format-console-ootb
- Repository: https://github.com/komiya-atsushi/winston-format-console-ootb
- Homepage: https://github.com/komiya-atsushi/winston-format-console-ootb#readme
- Issues: https://github.com/komiya-atsushi/winston-format-console-ootb/issues
- npm.io page: https://npm.io/package/winston-format-console-ootb

## 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

- 1.0.0 (latest) — 2021-01-18

## README

winston-format-console-ootb
=============================

Winston formatter for console output out-of-the-box.

Features
--------

- Preconfigured for console output.
    - Timestamp w/ time offset.
    - Colorized log level.
    - Stack trace if `Error` object is passed.
    - Pretty-printing of the meta object.
- Log name of the source file.
    - You need to pass `NodeModule` object to `prettyConsole()` and create a `winston.Logger` object for each source file.

Install
-------

```bash
# You need to explicitly install winston.
npm install \
  winston \
  winston-format-console-ootb
```

Demo
----

```typescript
import winston from 'winston';
import { prettyConsole } from 'winston-format-console-ootb';

const logger = winston.createLogger({
  level: 'silly',
  format: winston.format.errors({ stack: true }),
  transports: [
    new winston.transports.Console({
      format: prettyConsole(winston.config.npm.levels, module),
    }),
  ],
});

logger.silly('Lorem ipsum dolor sit amet');
logger.debug('consectetur adipiscing elit');
logger.verbose('sed do eiusmod tempor incididunt');
logger.info('ut labore et %s', 'dolore magna aliqua'); // use splat
logger.warn('Ut enim ad minim veniam', { num: 112358, str: '' }); // pass meta
logger.error('quis nostrud exercitation', new Error('ullamco laboris nisi ut aliquip')); // pass Error object
```

![Demo](docs/demo.png)

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