# mm-node-log-utils

> Utilitário para logging com cores

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

## Install

```sh
npm install mm-node-log-utils
pnpm add mm-node-log-utils
yarn add mm-node-log-utils
bun add mm-node-log-utils
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2020-02-02 |
| First published | 2020-02-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 205 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Maurício Marinho |
| Maintainers | maucrvlh |
| Keywords | log, colors |

## Links

- npm: https://www.npmjs.com/package/mm-node-log-utils
- Repository: https://github.com/maucrvlh/mm-node-log-utils
- Homepage: https://github.com/maucrvlh/mm-node-log-utils#readme
- Issues: https://github.com/maucrvlh/mm-node-log-utils/issues
- npm.io page: https://npm.io/package/mm-node-log-utils

## Dependencies (3)

- [colors](https://npm.io/package/colors.md) ^1.3.3
- [log-utils](https://npm.io/package/log-utils.md) ^1.0.0
- [on-headers](https://npm.io/package/on-headers.md) ^1.0.1

## 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-02-02
- 1.0.3 — 2020-02-02

## README

<h1 align="center">Logging Utils for Node.js</h1>

[![Version](https://img.shields.io/badge/Versão-v1.0.4-green.svg)](https://github.com/maucrvlh)

---

:fire: Utilitário para logging com cores

## Instalação usando npm
   
```
$ npm i mm-node-log-utils --save
```

## Instalação usando yarn (ligeiramente mais rápido)
   
```
$ yarn add mm-node-log-utils
```

## Utilização

### Logging da aplicação

```typescript
import * as log from 'mm-node-log-utils';
import settings from '../../config/settings';

const PORT = 8101;

log.setSettings(settings); // configura na lib as settings do sistema
                            // caso não haja esta configuração, a lib lançará um GenericErrorException


log.info(`${settings().system.name} rodando na porta ${PORT}.`);
log.debug('Debug #2 no index.js: ', { a: 1, b: 2 });
log.error('Ocorreu um erro. Objeto retornado: ', { a: 1, b: 2 });
log.log('Usuário acessou o sistema.');
log.success('sucesso na criação da entidade.');

```

### Configurando como plugin de log de requisições no ExpressJS 

```typescript
import * as express from 'express';
import * as bodyParser from 'body-parser';
import * as helmet from 'helmet';
import * as methodOverride from 'method-override';
import * as knex from 'knex';
import * as onHeaders from 'on-headers';
import settings from './settings';
import constants from './constants';
import routes from '../app/routes/all.js';

import * as log from 'mm-node-log-utils';
import { ConsumerNotAllowedException } from 'mm-node-exceptions';

export default function () {
    let app = express();


    log.setSettings(settings());

    app.use(log.plugin);

    
    app.use(bodyParser.urlencoded({ extended: true }));    
    app.use(bodyParser.json());
    app.use(methodOverride());
    app.use(helmet());
    
    //...

    

    return app;
}

```


## Exceções

#### GenericErrorException
>É necessário configurar as settings do sistema no utilitário de log usando o método .setSettings().

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