# logger-md

> A simple, lightweight, customizable cli logger that writes to stdout and stderr.

Latest version **0.0.31** (published 2018-05-30) · GPL-3.0 license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.31 |
| Published | 2018-05-30 |
| First published | 2017-07-15 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 483.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Marton Demeter |
| Maintainers | mdemeter |
| Keywords | log, logger |

## Links

- npm: https://www.npmjs.com/package/logger-md
- Repository: https://github.com/marton-demeter/logger-md
- Homepage: https://github.com/marton-demeter/logger-md#readme
- Issues: https://github.com/marton-demeter/logger-md/issues
- npm.io page: https://npm.io/package/logger-md

## Dependencies (2)

- [pad-md](https://npm.io/package/pad-md.md) ^0.0.2
- [colors-md](https://npm.io/package/colors-md.md) ^0.0.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.0.31 (latest) — 2018-05-30
- 0.0.29 — 2018-05-29
- 0.0.28 — 2018-05-29
- 0.0.27 — 2018-05-29
- 0.0.24 — 2017-08-05
- 0.0.23 — 2017-08-03
- 0.0.22 — 2017-08-03
- 0.0.20 — 2017-08-03
- 0.0.18 — 2017-08-03
- 0.0.17 — 2017-08-02
- 0.0.16 — 2017-07-27
- 0.0.15 — 2017-07-25
- 0.0.14 — 2017-07-20
- 0.0.13 — 2017-07-20
- 0.0.12 — 2017-07-20
- … 11 more at https://npm.io/package/logger-md/versions

## README

## Description

A simple, lightweight, customizable cli logger that writes to stdout and stderr.

It has 5 different message levels:

  * debug (stdout)
  * info (stdout)
  * success (stdout)
  * warning (stderr)
  * error (stderr)

## Installation

###### Local

```[sudo] npm install --save logger-md```

###### Global

```[sudo] npm install --global logger-md```

## Usage

```javascript
  const log = require('logger-md');
  
  log.debug(`This is a debug message`);
  log.info(`This is an info message`);
  log.success(`This is a success message`);
  log.warning(`This is a warning message`);
  log.error(`This is an error message`);
  
```

## Customization / API

### Colors

###### Enable / Disable

log.color.enable()<br>
log.color.disable()

###### All

log.color.token(color)<br>
log.color.level(color)<br>
log.color.message(color)

###### Specific

log.debug.color.token(color)<br>
log.debug.color.level(color)<br>
log.debug.color.message(color)

log.info.color.token(color)<br>
log.info.color.level(color)<br>
log.info.color.message(color)

log.success.color.token(color)<br>
log.success.color.level(color)<br>
log.success.color.message(color)

log.warning.color.token(color)<br>
log.warning.color.level(color)<br>
log.warning.color.message(color)

log.error.color.token(color)<br>
log.error.color.level(color)<br>
log.error.color.message(color)

### Characters

###### Disable

log.token.disable()<br>
log.level.disable()

###### All

log.set.token(token)<br>
log.set.level(level)

###### Specific

log.debug.token(token)<br>
log.debug.level(level)

log.info.token(token)<br>
log.info.level(level)

log.success.token(token)<br>
log.success.level(level)

log.warning.token(token)<br>
log.warning.level(level)

log.error.token(token)<br>
log.error.level(level)

### Alignment

log.align.token(align)<br>
log.align.level(align)

### Save / load state

log.save(preset)<br>
log.load(preset)

### Format

log.format(format)

###### Tokens

:tkn<br>
:padtkn<br>
:lvl<br>
:padlvl<br>
:msg

### Log level

log.level(level)

###### Levels

log.enum.debug<br>
log.enum.info<br>
log.enum.success<br>
log.enum.warning<br>
log.enum.error

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