@sido08/log-easy v1.0.2

log-easy

log-easy é uma biblioteca para facilitar a aplicação de cores e estilos no console do Node.js. Com log-easy, você pode adicionar cores e tags aos logs de maneira simples e intuitiva.

Instalação

Para instalar o log-easy, use o npm:

npm install log-easy

Uso

A biblioteca exporta duas coisas principais:

• easyLog: uma função para registrar textos coloridos no console.
• colors: um objeto que contém códigos de cores e estilos que você pode usar.

Importar

Para usar a biblioteca, importe easyLog e colors no seu código:

import { easyLog, colors } from 'log-easy';

Exemplo de Uso

Aqui estão alguns exemplos de como usar a função easyLog para registrar mensagens coloridas no console:

import { easyLog, colors } from 'log-easy';

// Registra uma mensagem em vermelho
easyLog('Hello World', 'red');

// Registra uma mensagem em azul com a tag 'INFO'
easyLog('Hello World', 'blue', 'INFO');

// Registra uma mensagem sem cor se a cor for inválida
easyLog('Hello World', 'invalidColor' as keyof typeof colors.fg);

// Registra uma mensagem sem cor e sem tag se a cor for inválida
easyLog('Hello World', 'invalidColor' as keyof typeof colors.fg, 'WARNING');

Parâmetros

• text (string): O texto que você deseja registrar.
• color (keyof typeof colors.fg): A cor que você deseja aplicar ao texto. As opções incluem black, red, green, yellow, blue, magenta, cyan, white, gray.
• tag (string, opcional): Uma tag opcional que será adicionada antes do texto.

Cores e Estilos

O objeto colors inclui os seguintes estilos e cores:

Estilos

• reset: \x1b[0m
• bright: \x1b[1m
• dim: \x1b[2m
• underline: \x1b[4m
• blink: \x1b[5m
• reverse: \x1b[7m
• hidden: \x1b[8m

Cores de Texto (fg)

• black: \x1b[30m
• red: \x1b[31m
• green: \x1b[32m
• yellow: \x1b[33m
• blue: \x1b[34m
• magenta: \x1b[35m
• cyan: \x1b[36m
• white: \x1b[37m
• gray: \x1b[90m

Cores de Fundo (bg)

• black: \x1b[40m
• red: \x1b[41m
• green: \x1b[42m
• yellow: \x1b[43m
• blue: \x1b[44m
• magenta: \x1b[45m
• cyan: \x1b[46m
• white: \x1b[47m

Testes

Para rodar os testes, use:

npm test

Contribuição

Sinta-se à vontade para contribuir para o log-easy! Abra uma issue ou envie um pull request.

Licença

Distribuído sob a licença MIT. Veja LICENSE para mais informações.