{"_id":"@abhixdevs/inklog","name":"@abhixdevs/inklog","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@abhixdevs/inklog","version":"1.0.0","main":"dist/index.js","types":"dist/index.d.ts","scripts":{"dev":"ts-node-dev --respawn --transpile-only src/index.ts","build":"tsc","start":"node dist/index.js","install-all":"ts-node-dev --transpile-only src/install-all.ts","uninstall-all":"ts-node-dev --transpile-only src/uninstall-all.ts"},"keywords":[],"author":{"name":"Abhishek - abhi.sankhwar22@gmail.com"},"license":"ISC","description":"A beautiful, lightweight logger for Node.js CLI applications.","dependencies":{"chalk":"^5.6.2","cors":"^2.8.6","dotenv":"^17.4.2","express":"^5.2.1","helmet":"^8.3.0","http-proxy-middleware":"^3.0.7","mongoose":"^9.7.4","morgan":"^1.11.0"},"devDependencies":{"@types/cors":"^2.8.19","@types/express":"^5.0.6","@types/morgan":"^1.9.10","@types/node":"^26.1.1","concurrently":"^10.0.3","ts-node-dev":"^2.0.0","typescript":"^5.4.5"},"_id":"@abhixdevs/inklog@1.0.0","_nodeVersion":"22.14.0","_npmVersion":"10.9.2","dist":{"integrity":"sha512-2TQeThQA/GaznlXkNsvg5wpxn+LjEDVfcVIC1v86rXdB6UiYtk1LAr+ZPhVr3Mlr/2anPJbI2RhZtxBAfptn5g==","shasum":"f4f2f5915794a547c1e4db5b9fd3ebcbfea79dd4","tarball":"https://registry.npmjs.org/@abhixdevs/inklog/-/inklog-1.0.0.tgz","fileCount":5,"unpackedSize":12128,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDGldmilXPxB+J0vTjxEhGEYzxKlqln/bz4JrpfjnZ7PwIhAO7x2//f8nw2/69d1LwhG7zZbsYY0R8jSri4YLGlc4pR"}]},"_npmUser":{"name":"abhixdevs","email":"abhi.sankhwar22@gmail.com"},"directories":{},"maintainers":[{"name":"abhixdevs","email":"abhi.sankhwar22@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/inklog_1.0.0_1784608026065_0.0758695624540271"},"_hasShrinkwrap":false}},"time":{"created":"2026-07-21T04:27:05.943Z","1.0.0":"2026-07-21T04:27:06.254Z","modified":"2026-07-21T04:27:06.458Z"},"maintainers":[{"name":"abhixdevs","email":"abhi.sankhwar22@gmail.com"}],"description":"A beautiful, lightweight logger for Node.js CLI applications.","keywords":[],"author":{"name":"Abhishek - abhi.sankhwar22@gmail.com"},"license":"ISC","readme":"# InkLog\r\n\r\n> 🚀 A beautiful, lightweight logger for Node.js CLI applications.\r\n\r\nTransform plain `console.log()` statements into clean, colorful, and structured terminal logs.\r\n\r\nPerfect for CLI tools, automation scripts, code generators, scaffolding tools, and internal developer platforms.\r\n\r\n---\r\n\r\n## ✨ Features\r\n\r\n- 🎨 Beautiful colored log levels\r\n- ✔ Built-in icons\r\n- 📏 Automatic text wrapping\r\n- 📐 Automatically adapts to terminal width\r\n- ⚙️ Configurable (colors & icons)\r\n- ⚡ Lightweight\r\n- 📦 Zero dependencies (except Chalk)\r\n- 🟦 Fully written in TypeScript\r\n\r\n---\r\n\r\n## Installation\r\n\r\n```bash\r\nnpm install @abhixdevs/inklog\r\n```\r\n\r\nor\r\n\r\n```bash\r\nyarn add @abhixdevs/inklog\r\n```\r\n\r\nor\r\n\r\n```bash\r\npnpm add @abhixdevs/inklog\r\n```\r\n\r\n---\r\n\r\n# Quick Start\r\n\r\n```ts\r\nimport {\r\n  successLog,\r\n  errorLog,\r\n  warningLog,\r\n  infoLog\r\n} from \"@abhixdevs/inklog\";\r\n\r\nsuccessLog(\"Service created successfully.\");\r\n\r\nwarningLog(\"Docker is not installed.\");\r\n\r\nerrorLog(\"Unable to connect to MongoDB.\");\r\n\r\ninfoLog(\"Starting authentication service...\");\r\n```\r\n\r\n---\r\n\r\n## Output\r\n\r\n```text\r\n───────────────────────────────────────────────────────────────────────────────\r\n\r\n✔ SUCCESS ─ Service created successfully.\r\n\r\n───────────────────────────────────────────────────────────────────────────────\r\n\r\n✖ ERROR ─ Unable to connect to MongoDB.\r\n\r\n───────────────────────────────────────────────────────────────────────────────\r\n\r\n⚠ WARNING ─ Docker is not installed.\r\n\r\n───────────────────────────────────────────────────────────────────────────────\r\n\r\nℹ INFO ─ Starting authentication service...\r\n\r\n───────────────────────────────────────────────────────────────────────────────\r\n```\r\n\r\nLong messages are automatically wrapped.\r\n\r\n```text\r\n───────────────────────────────────────────────────────────────────────────────\r\n\r\n✔ SUCCESS ─ Authentication service has been created successfully with routes,\r\n            interfaces, models, controllers and Docker configuration.\r\n\r\n───────────────────────────────────────────────────────────────────────────────\r\n```\r\n\r\n---\r\n\r\n# API\r\n\r\n## successLog()\r\n\r\nDisplays a success message.\r\n\r\n```ts\r\nsuccessLog();\r\n```\r\n\r\nDefault message\r\n\r\n```text\r\nOperation completed successfully\r\n```\r\n\r\n---\r\n\r\n## errorLog()\r\n\r\nDisplays an error message.\r\n\r\n```ts\r\nerrorLog();\r\n```\r\n\r\nDefault message\r\n\r\n```text\r\nAn unexpected error occurred\r\n```\r\n\r\n---\r\n\r\n## warningLog()\r\n\r\nDisplays a warning message.\r\n\r\n```ts\r\nwarningLog();\r\n```\r\n\r\nDefault message\r\n\r\n```text\r\nPotential issue identified\r\n```\r\n\r\n---\r\n\r\n## infoLog()\r\n\r\nDisplays an informational message.\r\n\r\n```ts\r\ninfoLog();\r\n```\r\n\r\nDefault message\r\n\r\n```text\r\nJust a heads up\r\n```\r\n\r\n---\r\n\r\n# Configuration\r\n\r\nInkLog allows you to configure colors and icons.\r\n\r\n## Disable Colors\r\n\r\n```ts\r\nimport { disableColors } from \"@abhixdevs/inklog\";\r\n\r\ndisableColors();\r\n```\r\n\r\n---\r\n\r\n## Enable Colors\r\n\r\n```ts\r\nimport { enableColors } from \"@abhixdevs/inklog\";\r\n\r\nenableColors();\r\n```\r\n\r\n---\r\n\r\n## Disable Icons\r\n\r\n```ts\r\nimport { disableIcons } from \"@abhixdevs/inklog\";\r\n\r\ndisableIcons();\r\n```\r\n\r\n---\r\n\r\n## Enable Icons\r\n\r\n```ts\r\nimport { enableIcons } from \"@abhixdevs/inklog\";\r\n\r\nenableIcons();\r\n```\r\n\r\n---\r\n\r\n## Configure Everything\r\n\r\n```ts\r\nimport { setLoggerConfig } from \"@abhixdevs/inklog\";\r\n\r\nsetLoggerConfig({\r\n    colors: false,\r\n    icons: true\r\n});\r\n```\r\n\r\n---\r\n\r\n# Example\r\n\r\n```ts\r\nimport {\r\n    successLog,\r\n    warningLog,\r\n    errorLog,\r\n    infoLog,\r\n    disableColors\r\n} from \"@abhixdevs/inklog\";\r\n\r\ndisableColors();\r\n\r\ninfoLog(\"Creating service...\");\r\n\r\nsuccessLog(\"Users service created.\");\r\n\r\nwarningLog(\"Redis is unavailable. Continuing without cache.\");\r\n\r\nerrorLog(\"Failed to connect to PostgreSQL.\");\r\n```\r\n\r\n---\r\n\r\n# Why InkLog?\r\n\r\nInstead of...\r\n\r\n```text\r\nConnected\r\nLoading...\r\nError\r\nDone\r\n```\r\n\r\nGet...\r\n\r\n```text\r\n───────────────────────────────────────────────────────────────────────────────\r\n\r\n✔ SUCCESS ─ Connected successfully.\r\n\r\n───────────────────────────────────────────────────────────────────────────────\r\n\r\nℹ INFO ─ Loading configuration...\r\n\r\n───────────────────────────────────────────────────────────────────────────────\r\n\r\n⚠ WARNING ─ Redis cache unavailable.\r\n\r\n───────────────────────────────────────────────────────────────────────────────\r\n\r\n✖ ERROR ─ Failed to connect to database.\r\n\r\n───────────────────────────────────────────────────────────────────────────────\r\n```\r\n\r\nInkLog makes CLI output easier to read, easier to debug, and much more professional.\r\n\r\n---\r\n\r\n# Use Cases\r\n\r\n- CLI Applications\r\n- Internal Developer Tools\r\n- Project Scaffolding\r\n- Automation Scripts\r\n- Build Pipelines\r\n- DevOps Utilities\r\n- Code Generators\r\n- Node.js Scripts\r\n\r\n---\r\n\r\n# License\r\n\r\nMIT\r\n\r\n---\r\n\r\n## Author\r\n\r\nBuilt with ❤️ by **Abhishek Sankhwar**\r\n\r\nIf you like this project, consider giving it a ⭐ on GitHub.","readmeFilename":"README.md","_rev":"1-1625e129650e8f838e557cdf93f9ccc0"}