@zahra633/inklog 1.0.0

package/README.md

@@ -0,0 +1,68 @@
+# @zahra633/inklog
+
+A lightweight, beautiful, and fully typed terminal logger for Node.js. `inklog` creates neatly formatted, colored boxes around your terminal messages using `chalk`, complete with status icons and automatic text wrapping so your logs never break terminal layout!
+
+## Features
+
+- 🎨 **Beautiful Formatting:** Automatically wraps text in elegant ASCII box-drawing characters.
+- 📐 **Smart Word Wrapping:** Detects your terminal width automatically and wraps long text without splitting words visually.
+- 🚦 **Status Icons:** Built-in recognizable prefixes for different log levels (✔, ✖, ⚠, ℹ).
+- 🌈 **Color Coded:** Uses `chalk` to colorize boxes based on the tone of your message (Green, Red, Yellow, Blue).
+- 📦 **Zero-Config:** Works out of the box with zero setup required.
+- 🛡️ **TypeScript Ready:** Written in TypeScript to provide excellent autocomplete and type definitions.
+
+## Installation
+
+You can install it via npm:
+
+```bash
+npm install @zahra633/inklog
+```
+
+## Usage
+
+You can import specific logging functions or the default object.
+
+### Import Functions Individually
+
+```typescript
+import { successLog, errorLog, warningLog, infoLog } from "@zahra633/inklog";
+
+successLog("Database connection established successfully!");
+errorLog("Failed to authenticate user: Invalid credentials.");
+warningLog("API rate limit is approaching.");
+infoLog("Server is running on port 3000.");
+```
+
+### Import as Default Object
+
+```typescript
+import inklog from "@zahra633/inklog";
+
+inklog.successLog("User profile updated!");
+
+// Works effortlessly with long strings and JSON objects:
+inklog.infoLog(
+  "This is a really long log message that is going to be dynamically wrapped based on your system's current terminal width without causing any overflow issues or messing up the box design whatsoever."
+);
+
+inklog.warningLog({ message: "You can even pass objects and get formatted JSON out!", status: 400 });
+```
+
+## API Reference
+
+### `successLog(msg: any)`
+Prints a green box with a checkmark (✔) icon. Ideal for success events.
+
+### `errorLog(msg: any)`
+Prints a red box with an X (✖) icon. Ideal for error events and exceptions.
+
+### `warningLog(msg: any)`
+Prints a yellow box with a warning (⚠) icon. Ideal for deprecations and warnings.
+
+### `infoLog(msg: any)`
+Prints a blue box with an info (ℹ) icon. Ideal for general logging and status updates.
+
+## License
+
+ISC License

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+export declare const successLog: (msg: any) => void;
+export declare const errorLog: (msg: any) => void;
+export declare const warningLog: (msg: any) => void;
+export declare const infoLog: (msg: any) => void;
+declare const inklog: {
+    successLog: (msg: any) => void;
+    errorLog: (msg: any) => void;
+    warningLog: (msg: any) => void;
+    infoLog: (msg: any) => void;
+};
+export default inklog;

package/dist/index.js

@@ -0,0 +1,89 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.infoLog = exports.warningLog = exports.errorLog = exports.successLog = void 0;
+const chalk_1 = __importDefault(require("chalk"));
+const log = console.log;
+const wrapText = (text, maxWidth) => {
+    const words = text.split(" ");
+    const lines = [];
+    let currentLine = "";
+    for (const word of words) {
+        if ((currentLine + (currentLine ? " " : "") + word).length <= maxWidth) {
+            currentLine += (currentLine ? " " : "") + word;
+        }
+        else {
+            if (currentLine)
+                lines.push(currentLine);
+            currentLine = word;
+            while (currentLine.length > maxWidth) {
+                lines.push(currentLine.substring(0, maxWidth));
+                currentLine = currentLine.substring(maxWidth);
+            }
+        }
+    }
+    if (currentLine)
+        lines.push(currentLine);
+    return lines;
+};
+const getPrefix = (type) => {
+    switch (type) {
+        case "success": return "✔";
+        case "error": return "✖";
+        case "warning": return "⚠";
+        case "info": return "ℹ";
+        default: return "";
+    }
+};
+const getColor = (type) => {
+    switch (type) {
+        case "success": return chalk_1.default.green;
+        case "error": return chalk_1.default.red;
+        case "warning": return chalk_1.default.yellow;
+        case "info": return chalk_1.default.blue;
+        default: return chalk_1.default.white;
+    }
+};
+const handler = (msg, type) => {
+    const textMsg = typeof msg === "string" ? msg : JSON.stringify(msg, null, 2) || "";
+    const columns = process.stdout.columns || 80;
+    const prefix = getPrefix(type);
+    const colorFn = getColor(type);
+    const prefixStr = prefix ? `${prefix} ` : "";
+    const extraCharsPerLine = 4 + prefixStr.length;
+    const maxLineWidth = Math.max(10, columns - extraCharsPerLine);
+    const lines = textMsg.split("\n").flatMap(line => wrapText(line, maxLineWidth));
+    const longestLine = Math.max(...lines.map(l => l.length), 0);
+    const dashLength = longestLine + prefixStr.length + 2;
+    const dash = "─".repeat(dashLength);
+    log(colorFn(`┌${dash}┐`));
+    for (let i = 0; i < lines.length; i++) {
+        const line = lines[i];
+        const paddedLine = line.padEnd(longestLine, " ");
+        if (i === 0) {
+            log(colorFn(`│ ${prefixStr}${paddedLine} │`));
+        }
+        else {
+            const emptyPrefix = " ".repeat(prefixStr.length);
+            log(colorFn(`│ ${emptyPrefix}${paddedLine} │`));
+        }
+    }
+    log(colorFn(`└${dash}┘`));
+};
+const successLog = (msg) => handler(msg, "success");
+exports.successLog = successLog;
+const errorLog = (msg) => handler(msg, "error");
+exports.errorLog = errorLog;
+const warningLog = (msg) => handler(msg, "warning");
+exports.warningLog = warningLog;
+const infoLog = (msg) => handler(msg, "info");
+exports.infoLog = infoLog;
+const inklog = { successLog: exports.successLog, errorLog: exports.errorLog, warningLog: exports.warningLog, infoLog: exports.infoLog };
+exports.default = inklog;
+// Testing logs
+(0, exports.successLog)("This is a success message");
+(0, exports.errorLog)("This is an error message");
+(0, exports.warningLog)("This is a warning message");
+(0, exports.infoLog)("This is an info message. We can test the automatic word wrapping feature by providing a really long text that will dynamically wrap into the next line. This prevents overflow or messy formatting issues in the terminal output!");

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@zahra633/inklog",
+  "version": "1.0.0",
+  "description": "A colorful and beautiful terminal logger for Node.js with fixed-width output and icons",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "dev": "ts-node-dev --transpile-only src/index.ts",
+    "build": "tsc",
+    "start": "node dist/index.js"
+  },
+  "keywords": [
+    "console",
+    "pretty-logger",
+    "colored-logs",
+    "log-formatter",
+    "dev-logger",
+    "inklog"
+  ],
+  "author": "@zahra633/inklog - Zahra",
+  "license": "MIT",
+  "homepage": "https://github.com/shayanalikhan888/inklog#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shayanalikhan888/inklog.git"
+  },
+  "bugs": {
+    "url": "https://github.com/shayanalikhan888/inklog/issues"
+  },
+  "type": "commonjs",
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "cookie-parser": "^1.4.7",
+    "cors": "^2.8.6",
+    "dotenv": "^17.3.1",
+    "express": "^5.2.1",
+    "inquirer": "^13.3.0",
+    "mongoose": "^9.2.1",
+    "morgan": "^1.10.1"
+  },
+  "devDependencies": {
+    "@types/cookie-parser": "^1.4.10",
+    "@types/cors": "^2.8.19",
+    "@types/express": "^5.0.6",
+    "@types/morgan": "^1.9.10",
+    "@types/node": "^25.5.0",
+    "ts-node-dev": "^2.0.0",
+    "typescript": "^5.9.3"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "target": "es2022",
+    "module": "commonjs",
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "types": [
+      "node"
+    ],
+    "declaration": true
+  },
+  "include": [
+    "src"
+  ],
+  "exclude": [
+    "node_modules",
+    "templates"
+  ]
+}