debug-lite-js 1.0.0

package/README.md

@@ -0,0 +1,113 @@
+# debug-lite-js
+
+Utilitário Node.js para facilitar o debug de aplicações backend com logs estruturados, pretty print, timers e captura de erros.
+
+## Recursos
+
+- Logs inteligentes com níveis `info`, `warn`, `error` e `debug`
+- Timestamp em cada mensagem
+- Cores no console com `chalk`
+- Pretty print de objetos JSON e nested objects
+- Debug condicional via `DEBUG=true`
+- Timer de execução com `startTimer` / `endTimer`
+- Função de captura de erros com stack trace formatado
+
+## Instalação
+
+```bash
+npm install debug-lite-js
+```
+
+## Uso básico
+
+```javascript
+const debug = require('debug-lite-js');
+
+debug.info('Servidor iniciado');
+debug.warn('Espaço em disco baixo');
+debug.error('Erro inesperado');
+
+debug.debug('Dados de depuração', { user: 'admin' });
+
+debug.pretty({
+  user: 'admin',
+  roles: ['admin', 'editor'],
+  profile: { age: 30, active: true },
+});
+```
+
+## Exemplo real em Express
+
+```javascript
+const express = require('express');
+const debug = require('debug-lite-js');
+
+const app = express();
+const port = process.env.PORT || 3000;
+
+app.use(express.json());
+
+app.use((req, res, next) => {
+  debug.info('Request recebida', { method: req.method, path: req.path });
+  if (debug.isDebugEnabled()) {
+    debug.pretty({ headers: req.headers, query: req.query, body: req.body });
+  }
+  next();
+});
+
+app.get('/', (req, res) => {
+  debug.startTimer('home-route');
+  res.send('Hello World');
+  debug.endTimer('home-route');
+});
+
+app.get('/users/:id', async (req, res) => {
+  const userId = req.params.id;
+  debug.info('Buscando usuário', userId);
+  debug.startTimer('fetch-user');
+
+  try {
+    // Simula busca de usuário
+    const user = { id: userId, name: 'Maria', role: 'admin' };
+    debug.pretty(user);
+    res.json(user);
+  } catch (error) {
+    debug.logError(error, 'Falha ao buscar usuário');
+    res.status(500).json({ error: 'Erro interno' });
+  } finally {
+    debug.endTimer('fetch-user');
+  }
+});
+
+app.use((err, req, res, next) => {
+  debug.logError(err, 'Erro de middleware');
+  res.status(500).json({ error: 'Erro interno do servidor' });
+});
+
+app.listen(port, () => {
+  debug.info(`Servidor Express rodando na porta ${port}`);
+});
+```
+
+## Ativar logs de debug
+
+```bash
+DEBUG=true node app.js
+```
+
+## API Exportada
+
+- `log(level, message, ...meta)`
+- `info(message, ...meta)`
+- `warn(message, ...meta)`
+- `error(message, ...meta)`
+- `debug(message, ...meta)`
+- `logError(error, message)`
+- `isDebugEnabled()`
+- `pretty(value, options)`
+- `startTimer(label)`
+- `endTimer(label, options)`
+
+---
+
+`debug-lite-js` foi criado para tornar as rotinas de depuração mais visuais e rápidas no Node.js.

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "debug-lite-js",
+  "version": "1.0.0",
+  "description": "Utility module for improved Node.js debugging with structured logs, pretty printing, timers, and error capture.",
+  "main": "src/index.js",
+  "files": ["src", "README.md"],
+  "keywords": ["debug", "logger", "node", "pretty-print", "timer", "errors"],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "chalk": "^4.1.2"
+  }
+}

package/src/formatter.js

@@ -0,0 +1,21 @@
+const chalk = require('chalk');
+const util = require('util');
+
+function pretty(value, options = {}) {
+  const defaultOptions = {
+    depth: 6,
+    colors: true,
+    compact: false,
+    sorted: true,
+  };
+
+  const config = Object.assign({}, defaultOptions, options);
+  const output = util.inspect(value, config);
+
+  console.log(chalk.cyan.bold('[PRETTY PRINT]'));
+  console.log(output);
+}
+
+module.exports = {
+  pretty,
+};

package/src/index.js

@@ -0,0 +1,16 @@
+const logger = require('./logger');
+const formatter = require('./formatter');
+const timer = require('./timer');
+
+module.exports = {
+  log: logger.log,
+  info: logger.info,
+  warn: logger.warn,
+  error: logger.error,
+  debug: logger.debug,
+  logError: logger.logError,
+  isDebugEnabled: logger.isDebugEnabled,
+  pretty: formatter.pretty,
+  startTimer: timer.startTimer,
+  endTimer: timer.endTimer,
+};

package/src/logger.js

@@ -0,0 +1,57 @@
+const chalk = require('chalk');
+
+const levels = {
+  info: { label: 'INFO', color: chalk.blue },
+  warn: { label: 'WARN', color: chalk.yellow },
+  error: { label: 'ERROR', color: chalk.red },
+  debug: { label: 'DEBUG', color: chalk.magenta },
+};
+
+function getTimestamp() {
+  return new Date().toISOString();
+}
+
+function isDebugEnabled() {
+  const value = process.env.DEBUG;
+  return value === 'true' || value === '1' || value === 'all' || value === 'yes';
+}
+
+function formatLog(level, message) {
+  const info = levels[level] || levels.info;
+  const label = info.label;
+  return `[${getTimestamp()}] [${label}] ${message}`;
+}
+
+function log(level, message, ...meta) {
+  const normalizedLevel = String(level || 'info').toLowerCase();
+  if (normalizedLevel === 'debug' && !isDebugEnabled()) {
+    return;
+  }
+
+  const info = levels[normalizedLevel] || levels.info;
+  const formatted = info.color(formatLog(normalizedLevel, message));
+
+  if (normalizedLevel === 'error') {
+    console.error(formatted, ...meta);
+  } else if (normalizedLevel === 'warn') {
+    console.warn(formatted, ...meta);
+  } else {
+    console.log(formatted, ...meta);
+  }
+}
+
+function logError(error, message = '') {
+  const header = message ? `${message} - ` : '';
+  const stack = error && error.stack ? error.stack : String(error);
+  log('error', `${header}${stack}`);
+}
+
+module.exports = {
+  log,
+  info: (message, ...meta) => log('info', message, ...meta),
+  warn: (message, ...meta) => log('warn', message, ...meta),
+  error: (message, ...meta) => log('error', message, ...meta),
+  debug: (message, ...meta) => log('debug', message, ...meta),
+  logError,
+  isDebugEnabled,
+};

package/src/timer.js

@@ -0,0 +1,31 @@
+const timers = new Map();
+
+function startTimer(label = 'default') {
+  timers.set(label, process.hrtime.bigint());
+}
+
+function endTimer(label = 'default', options = {}) {
+  const start = timers.get(label);
+  if (!start) {
+    throw new Error(`Timer '${label}' was not started.`);
+  }
+
+  const durationNs = process.hrtime.bigint() - start;
+  timers.delete(label);
+  const durationMs = Number(durationNs) / 1e6;
+  const message = `${label}: ${durationMs.toFixed(3)} ms`;
+
+  if (options.log !== false) {
+    console.log(message);
+  }
+
+  return {
+    label,
+    durationMs,
+  };
+}
+
+module.exports = {
+  startTimer,
+  endTimer,
+};