@helzady/zady 1.0.0 → 1.2.0

package/README.md

@@ -1,78 +1,174 @@
-# zady
+# Zady
 
-Biblioteca leve para logs no Node.js com suporte a cores, prefixos, timestamp e controle de erros.
+Logger leve para Node.js com saída colorida no terminal.
 
 ---
 
 ## 📦 Instalação
 
 ```bash
-npm install zady
+npm install @helzady/zady
 ```
 
 ---
 
-## 🚀 Uso básico
+## 🚀 Uso
 
 ```ts
-// Importa funções da biblioteca
-import { log, warn, error, success, crash } from "@helzady/logger"
+import zady from "@helzady/zady";
+
+zady.log("Mensagem de debug");
+zady.info("Servidor iniciado na porta 3000");
+zady.warn("Variável de ambiente não definida");
+zady.success("Conexão estabelecida");
+zady.error("Falha crítica", { error: new Error("stack trace aqui") });
+zady.debug("Valor da variável x: 42");
+zady.divider();
+zady.timer("query ao banco");
+```
 
-// Log padrão
-log("Mensagem simples")
+Ou com destructuring:
 
-// Aviso
-warn("Atenção")
+```ts
+import { log, info, warn, success, error, debug, divider, timer } from "@helzady/zady";
+```
 
-// Erro
-error("Algo deu errado")
+---
 
-// Sucesso
-success("Operação concluída")
+## 🧾 Saída
 
-// Erro fatal (encerra o processo)
-crash("Erro crítico")
+```bash
+[18/05/2026 14:00] [LOG]     Mensagem de debug
+[18/05/2026 14:00] [INFO]    Servidor na porta 3000
+[18/05/2026 14:00] [WARN]    Variável de ambiente não definida
+[18/05/2026 14:00] [SUCCESS] Conexão estabelecida
+[18/05/2026 14:00] [ERROR]   Falha crítica
+[18/05/2026 14:00] [DEBUG]   Valor da variável x: 42
+────────────────────────────────────────
+[18/05/2026 14:00] [TIMER]   query ao banco — 42.31ms
 ```
 
+> As cores e o formato dos logs são aplicados via ANSI no terminal.
+
 ---
 
-## ⚙️ Opções do crash
+## 📌 Funções disponíveis
+
+| Função                       | Prefixo   | Cor      | Descrição                                          |
+| ---------------------------- | --------- | -------- | -------------------------------------------------- |
+| `log(message)`               | `LOG`     | Cinza    | Debug e mensagens de desenvolvimento               |
+| `info(message)`              | `INFO`    | Azul     | Informações relevantes do sistema                  |
+| `warn(message)`              | `WARN`    | Amarelo  | Avisos que não encerram o processo                 |
+| `success(message)`           | `SUCCESS` | Verde    | Confirmação de operações bem-sucedidas             |
+| `error(message, options?)`   | `ERROR`   | Vermelho | Erro crítico — **encerra o processo**              |
+| `debug(message)`             | `DEBUG`   | Magenta  | Log condicional — só exibe quando `DEBUG=true`     |
+| `divider(char?, length?)`    | —         | Cinza    | Linha separadora no terminal                       |
+| `timer(label)`               | `TIMER`   | Ciano    | Mede o tempo de uma operação                       |
+
+---
+
+## ⚙️ Opções da função `error`
+
+A função `error` aceita um segundo argumento com as seguintes opções:
 
 ```ts
-crash("Erro crítico", {
-  code: 1, // Código de saída do processo
-  prefix: "FATAL", // Prefixo da mensagem
-  showStack: true, // Mostrar stack trace
-  timestamp: true, // Mostrar data/hora
-  error: new Error("Detalhes do erro") // Objeto de erro
+error("Mensagem de erro", {
+  code?: number       // código de saída do processo (padrão: 1)
+  prefix?: string     // prefixo customizado (padrão: "ERROR")
+  showStack?: boolean // exibir stack trace (padrão: true)
+  timestamp?: boolean // exibir data/hora (padrão: true)
+  error?: unknown     // objeto de erro para exibir o stack
 })
 ```
 
+Exemplo:
+
+```ts
+try {
+  // ...
+} catch (err) {
+  error("Falha ao conectar ao banco", {
+    code: 1,
+    error: err,
+    showStack: true,
+  });
+}
+```
+
 ---
 
-## 🎨 Recursos
+## 🐛 Debug
+
+A função `debug` só exibe logs quando a variável de ambiente `DEBUG=true` estiver ativa:
+
+```ts
+debug("Valor da variável x: 42");
+```
 
-* Logs coloridos (ANSI)
-* Prefixos personalizados
-* Timestamp formatado (DD/MM/YYYY HH:mm)
-* Stack trace opcional
-* Encerramento seguro do processo
+```bash
+DEBUG=true node app.js
+```
 
 ---
 
-## 📁 Estrutura
+## ─ Divider
 
+Imprime uma linha separadora para organizar a saída do terminal:
+
+```ts
+divider()          // ────────────────────────────────────────
+divider("=", 20)   // ====================
+divider("*", 10)   // **********
 ```
-src/
- ├── core/        # Núcleo (formatter, colors, types)
- ├── functions/   # Funções principais (log, error, etc)
- ├── utils/       # Utilitários internos
- ├── config/      # Configurações padrão
- └── index.ts     # Entry point
+
+---
+
+## ⏱ Timer
+
+Mede o tempo de execução de uma operação:
+
+```ts
+const t = timer("query ao banco");
+
+await db.query("SELECT ...");
+
+t.stop("Query concluída");
+// → [TIMER] Query concluída — 42.31ms
+
+// ou sem mensagem
+t.stop();
+// → [TIMER] query ao banco — 42.31ms
 ```
 
 ---
 
+## 🎨 Estilos
+
+A lib também expõe utilitários de estilo ANSI para uso direto no terminal:
+
+```ts
+import zady from "@helzady/zady";
+
+const { colors, bgColors, terminalStyle } = zady.style;
+
+console.log(`${colors.cyan}Texto ciano${terminalStyle.reset}`);
+console.log(`${bgColors.red}Fundo vermelho${terminalStyle.reset}`);
+```
+
+### `colors`
+
+`black` · `red` · `green` · `yellow` · `blue` · `magenta` · `cyan` · `white` · `gray`
+
+### `bgColors`
+
+`black` · `red` · `green` · `yellow` · `blue` · `magenta` · `cyan` · `white`
+
+### `terminalStyle`
+
+`reset` · `negrito` · `fraco` · `italico` · `sublinhado` · `riscado`
+
+---
+
 ## 📄 Licença
 
-MIT License
+MIT — [HelzadyDev](https://github.com/HelzadyDev)

package/package.json

@@ -1,6 +1,9 @@
 {
   "name": "@helzady/zady",
-  "version": "1.0.0",
+  "version": "1.2.0",
+  "publishConfig": {
+    "access": "public"
+  },
   "description": "um logger simples e poderoso para Node.js, com saídas formatadas no console, tratamento de erros e utilitários focados no desenvolvedor.",
   "homepage": "https://github.com/HelzadyDev/zady#readme",
   "bugs": {
@@ -11,7 +14,7 @@
     "url": "git+https://github.com/HelzadyDev/zady.git"
   },
   "license": "MIT",
-  "author": "Helzady",
+  "author": "HelzadyDev",
   "type": "module",
   "files": [
     "build"

package/build/config/defaults.d.ts

@@ -1,6 +0,0 @@
-export declare const defaults: {
-    prefix: string;
-    code: number;
-    showStack: boolean;
-    timeStamp: boolean;
-};

package/build/config/defaults.js

@@ -1,6 +0,0 @@
-export const defaults = {
-    prefix: "LOGGER",
-    code: 1,
-    showStack: true,
-    timeStamp: true,
-};

package/build/config/index.d.ts

@@ -1 +0,0 @@
-export * from "./defaults.js";

package/build/config/index.js

@@ -1 +0,0 @@
-export * from "./defaults.js";

package/build/core/colors.d.ts

@@ -1,21 +0,0 @@
-export declare const colors: {
-    black: string;
-    red: string;
-    green: string;
-    yellow: string;
-    blue: string;
-    magenta: string;
-    cyan: string;
-    white: string;
-    gray: string;
-};
-export declare const bgColors: {
-    black: string;
-    red: string;
-    green: string;
-    yellow: string;
-    blue: string;
-    magenta: string;
-    cyan: string;
-    white: string;
-};

package/build/core/colors.js

@@ -1,22 +0,0 @@
-// Define cores ANSI para terminal
-export const colors = {
-    "black": "\x1b[30",
-    "red": "\x1b[31m",
-    "green": "\x1b[32m",
-    "yellow": "\x1b[33m",
-    "blue": "\x1b[34m",
-    "magenta": "\x1b[35",
-    "cyan": "\x1b[36",
-    "white": "\x1b[37m",
-    "gray": "\x1b[90m",
-};
-export const bgColors = {
-    "black": "\x1b[40m",
-    "red": "\x1b[41m",
-    "green": "\x1b[42m",
-    "yellow": "\x1b[43m",
-    "blue": "\x1b[44m",
-    "magenta": "\x1b[45m",
-    "cyan": "\x1b[46m",
-    "white": "\x1b[47m",
-};

package/build/core/formatter.d.ts

@@ -1 +0,0 @@
-export declare function formatMenssage(message: string, prefix: string, color: string, useTimestamp: boolean): string;

package/build/core/formatter.js

@@ -1,9 +0,0 @@
-import { colors, terminalStyle } from "#core";
-import { getTimestamp } from "#utils";
-// Função responsavel por montar a mensagem fatal
-export function formatMenssage(message, prefix, color, useTimestamp) {
-    const time = useTimestamp
-        ? `${colors.gray}[${getTimestamp()}]${terminalStyle.reset}`
-        : "";
-    return `${time}${color}[${prefix}]${terminalStyle.reset} ${message}`;
-}

package/build/core/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./colors.js";
-export * from "./types.js";
-export * from "./formatter.js";
-export * from "./terminalStyle.js";

package/build/core/index.js

@@ -1,4 +0,0 @@
-export * from "./colors.js";
-export * from "./types.js";
-export * from "./formatter.js";
-export * from "./terminalStyle.js";

package/build/core/terminalStyle.d.ts

@@ -1,8 +0,0 @@
-export declare const terminalStyle: {
-    reset: string;
-    negrito: string;
-    fraco: string;
-    italico: string;
-    sublinhado: string;
-    riscado: string;
-};

package/build/core/terminalStyle.js

@@ -1,8 +0,0 @@
-export const terminalStyle = {
-    "reset": "\x1b[0m", // Reseta cor
-    "negrito": "\x1b[1m", // Formata o texto em negrito
-    "fraco": "\x1b[2m",
-    "italico": "\x1b[3m",
-    "sublinhado": "\x1b[4m",
-    "riscado": "\x1b[9m",
-};

package/build/core/types.d.ts

@@ -1,7 +0,0 @@
-export interface ErrorOptions {
-    code?: number;
-    prefix?: string;
-    showStack?: boolean;
-    timestamp?: boolean;
-    error?: unknown;
-}

package/build/core/types.js

@@ -1,2 +0,0 @@
-;
-export {};

package/build/functions/error.d.ts

@@ -1,2 +0,0 @@
-import { ErrorOptions } from "#core";
-export declare function error(message: string, options?: ErrorOptions): never;

package/build/functions/error.js

@@ -1,19 +0,0 @@
-// import { colors, formatMenssage } from "#core";
-// // log de erro
-// export function error(message: string): void {
-//     console.error(formatMenssage(message, "ERROR", colors.red, true))
-// }
-import { colors, formatMenssage } from "#core";
-import { defaults } from "#config";
-// função fatal que encerra o processo
-export function error(message, options = {}) {
-    const { code = defaults.code, prefix = "FATAL", showStack = defaults.showStack, timestamp = defaults.timeStamp, error, } = options;
-    // Exibe mensagen formatada
-    console.error(formatMenssage(message, prefix, colors.red, timestamp));
-    // Exibe stack trace se existir
-    if (showStack && error instanceof Error) {
-        console.error(error.stack);
-    }
-    // Encerra o processo
-    process.exit(code);
-}

package/build/functions/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./error.js";
-export * from "./log.js";
-export * from "./success.js";
-export * from "./warn.js";

package/build/functions/index.js

@@ -1,4 +0,0 @@
-export * from "./error.js";
-export * from "./log.js";
-export * from "./success.js";
-export * from "./warn.js";

package/build/functions/log.d.ts

@@ -1 +0,0 @@
-export declare function log(message: string): void;

package/build/functions/log.js

@@ -1,5 +0,0 @@
-import { colors, formatMenssage } from "#core";
-// Log padrão (info)
-export function log(message) {
-    console.log(formatMenssage(message, "INFO", colors.blue, true));
-}

package/build/functions/success.d.ts

@@ -1 +0,0 @@
-export declare function success(message: string): void;

package/build/functions/success.js

@@ -1,5 +0,0 @@
-import { colors, formatMenssage } from "#core";
-// Log de sucesso
-export function success(message) {
-    console.log(formatMenssage(message, "SUCCESS", colors.green, true));
-}

package/build/functions/warn.d.ts

@@ -1 +0,0 @@
-export declare function warn(message: string): void;

package/build/functions/warn.js

@@ -1,5 +0,0 @@
-import { colors, formatMenssage } from "#core";
-// log de aviso
-export function warn(message) {
-    console.log(formatMenssage(message, "WARN", colors.yellow, true));
-}

package/build/index.d.ts

@@ -1,38 +0,0 @@
-declare const logger: {
-    style: {
-        bgColors: {
-            black: string;
-            red: string;
-            green: string;
-            yellow: string;
-            blue: string;
-            magenta: string;
-            cyan: string;
-            white: string;
-        };
-        colors: {
-            black: string;
-            red: string;
-            green: string;
-            yellow: string;
-            blue: string;
-            magenta: string;
-            cyan: string;
-            white: string;
-            gray: string;
-        };
-        terminalStyle: {
-            reset: string;
-            negrito: string;
-            fraco: string;
-            italico: string;
-            sublinhado: string;
-            riscado: string;
-        };
-    };
-    error(message: string, options?: import("#core").ErrorOptions): never;
-    log(message: string): void;
-    success(message: string): void;
-    warn(message: string): void;
-};
-export default logger;

package/build/index.js

@@ -1,11 +0,0 @@
-import * as functions from "#functions";
-import { bgColors, colors, terminalStyle } from "#core";
-const logger = {
-    ...functions,
-    style: {
-        bgColors,
-        colors,
-        terminalStyle
-    }
-};
-export default logger;

package/build/utils/formatDate.d.ts

@@ -1 +0,0 @@
-export declare function getTimestamp(): string;

package/build/utils/formatDate.js

@@ -1,10 +0,0 @@
-// Retorna data no formato DD/MM/YYYY HH:mm
-export function getTimestamp() {
-    const now = new Date();
-    const day = String(now.getDate()).padStart(2, "0");
-    const month = String(now.getMonth() + 1).padStart(2, "0");
-    const year = now.getFullYear();
-    const hours = String(now.getHours()).padStart(2, "0");
-    const minutes = String(now.getMinutes()).padStart(2, "0");
-    return `${day}/${month}/${year} ${hours}:${minutes}`;
-}

package/build/utils/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./formatDate.js";
-export * from "./precess.js";

package/build/utils/index.js

@@ -1,2 +0,0 @@
-export * from "./formatDate.js";
-export * from "./precess.js";

package/build/utils/precess.d.ts

@@ -1 +0,0 @@
-export declare function exitProcess(code: string): never;

package/build/utils/precess.js

@@ -1,4 +0,0 @@
-// wrapper do proces.exit
-export function exitProcess(code) {
-    process.exit(code);
-}