# labelled-logger

> A logger featuring customizable labels, colors, log levels and more.

Latest version **1.0.4** (published 2020-03-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install labelled-logger
pnpm add labelled-logger
yarn add labelled-logger
bun add labelled-logger
```

## 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.4 |
| Published | 2020-03-22 |
| First published | 2020-01-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 5.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Emmanuel |
| Maintainers | exifers |
| Keywords | logger, log, levels, color, labels |

## Links

- npm: https://www.npmjs.com/package/labelled-logger
- npm.io page: https://npm.io/package/labelled-logger

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) ^3.0.0
- [sprintf-js](https://npm.io/package/sprintf-js.md) ^1.1.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

- 1.0.4 (latest) — 2020-03-22
- 1.0.3 — 2020-01-06
- 1.0.2 — 2020-01-06
- 1.0.1 — 2020-01-06
- 1.0.0 — 2020-01-06

## README

# labelled-logger
[![npm version](https://img.shields.io/npm/v/labelled-logger.svg?style=flat-square)](https://www.npmjs.com/package/labelled-logger)
[![install size](https://badgen.net/packagephobia/install/labelled-logger)](https://packagephobia.now.sh/result?p=labelled-logger)
[![downloads](https://img.shields.io/npm/dm/labelled-logger.svg?style=flat-square)](https://npm-stat.com/charts.html?package=labelled-logger)


Features:
- colored log labels
- log levels
- nicely displayed
- printf-like message formatting
- configurable and customizable

![demo](https://i.ibb.co/M1BJjpy/demo.gif)

## Table of Contents
- [Usage](#usage)

## Usage

```javascript
const LoggerFactory = require('labelled-logger');
const colors = require('labelled-logger').colors;

const labelsData = [
  {
    label: 'prepare',
    color: colors.GREEN
  },
  {
    label: 'parse',
    color: colors.PURPLE
  },
  {
    label: 'extract', 
    color: colors.BLUE
  },
  {
    label: 'compute',
    color: colors.RED
  },
  {
    label: 'create',
    color: colors.YELLOW
  }
];

const levelsData = [
  { value: 0 }, { value: 1 }, { value: 2 }, { value: 3 }
];

const logger = LoggerFactory.createLogger(labelsData, levelsData);
logger.setLevel(1); // everything below or equal level 1 will be printed
logger.setExpandObjects(true); // objects and lists will be printed entirely
logger.disable(); // don't log anything
logger.enable('create', 'compute'); // log only create and compute labels
logger.enable(); // log all labels


// log messages in your code
// logger.log(<level>, <label>, <message>, ...<variables>)

logger.log(0, 'prepare', 'reading file');
/* ... */
logger.log(1, 'prepare', '%d lines read', lines);
/* ... */
logger.log(1, 'parse', 'parsed file, parsed returned %s', ret);
```

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