# supreme-log

> This is a project of the Advanced Software Development course of the University of Brasília and consists of an framework in Node.js using aspect oriented programming.

Latest version **1.0.4** (published 2017-12-06) · ISC license · 0 weekly downloads

## Install

```sh
npm install supreme-log
pnpm add supreme-log
yarn add supreme-log
bun add supreme-log
```

## 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 | 2017-12-06 |
| First published | 2017-12-02 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Carolina Ferreira |
| Maintainers | carolinaferreira |
| Keywords | ['logging', 'log', 'aspect'] |

## Links

- npm: https://www.npmjs.com/package/supreme-log
- Repository: https://github.com/carolinaferreira/DAS
- Homepage: https://github.com/carolinaferreira/DAS#readme
- Issues: https://github.com/carolinaferreira/DAS/issues
- npm.io page: https://npm.io/package/supreme-log

## Dependencies (1)

- [aspectjs](https://npm.io/package/aspectjs.md) ^2.0.4

## 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) — 2017-12-06
- 1.0.3 — 2017-12-02
- 1.0.2 — 2017-12-02
- 1.0.1 — 2017-12-02
- 1.0.0 — 2017-12-02

## README

# Supreme Log

O Supreme Log é um framework para aplicações em Node.js que utiliza programação orientada a aspectos que permite fazer o logging de uma ou mais classes de forma personalizada, facilitando o tracing e debugging. O projeto foi desenvolvido no Segundo semestre de 2017 como parte da disciplina de Desenvolvimento Avançado de Software ministrada pelo Professor André Luiz Peron Martins Lanna.

Para instalar o framework, digite no terminal:

$ npm install supreme-log

Como importar o Supreme Log para o seu projeto:

const SupremeLog = require('supreme-log');

Existem duas opções de log:

Before - registra o log antes que o método seja executado.
SupremeLog.before(this);

After - registra o log depois da execução do método.
SupremeLog.after(this);

Como parâmetros, deve ser passada obrigatoriamente a classe em que deseja ser realizada o log e opcionalmente um array contendo o nome dos métodos da classe que desejamos que o logging acompanhe. Por exemplo:
SupremeLog.after(this, ['trackenMethod2', 'trackenMethod4']);

Por padrão, é definido que o log seja salvo em um arquivo chamado 'supreme.log' na pasta raiz do projeto, para mudar essa opção para que o log possa aparecer no console:

SupremeLog.logFile = false

Para que não seja apresentada a data e o tempo à cada log:

SupremeLog.useTime = false

Há ainda no projeto o arquivo examples/test.js que demonstra a utilização do Supreme Log, para referências.

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