@ptdlib/quicklog 1.0.2

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Initial project setup
+
+## [1.0.0] - YYYY-MM-DD
+
+### Added
+- Initial release

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2026, PaxtonTerryDev
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,24 @@
+# Quicklog
+
+A minimal, color-coded logging utility for Node.js and TypeScript applications. Quicklog provides five log levels (debug, info, warn, error, fatal) with distinct color formatting via chalk, optional timestamps, and automatic suppression of debug messages in production. It requires no configuration to get started—just import and use.
+
+To install, run `npm install @paxtonterrydev/quicklog`. Import the `log` object and call the appropriate method for your message severity. Debug messages are hidden when `NODE_ENV=production`, and calling `log.fatal()` sets `process.exitCode = 1` for graceful shutdown handling. Enable timestamps by setting `log.timestamp = true`.
+
+## Usage
+
+```typescript
+import { log } from '@paxtonterrydev/quicklog';
+
+log.debug('Only shown in development');
+log.info('Application started');
+log.warn('Deprecated feature used');
+log.error('Failed to connect');
+log.fatal('Unrecoverable error'); // Sets process.exitCode = 1
+
+// Enable timestamps
+log.timestamp = true;
+log.info('Message with timestamp');
+
+// Log objects with full depth
+log.object({ nested: { data: { here: true } } });
+```

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Main logging utility object providing color-coded console output at various log levels.
+ *
+ * @example
+ * ```typescript
+ * import { log } from '@paxtonterrydev/quicklog';
+ *
+ * log.info('Server started');
+ * log.warn('Deprecated API usage');
+ * log.error('Connection failed');
+ *
+ * // Enable timestamps
+ * log.timestamp = true;
+ * log.info('This message includes a timestamp');
+ * ```
+ */
+export declare const log: Log;
+/** Function signature for log level methods. */
+type LogFunction = (message: string, ...args: unknown[]) => void;
+/** The main log object interface. */
+interface Log {
+    timestamp: boolean;
+    debug: LogFunction;
+    info: LogFunction;
+    warn: LogFunction;
+    error: LogFunction;
+    fatal: LogFunction;
+    object: (object: Object) => void;
+}
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,GAAG,EAAE,GA2DjB,CAAA;AAED,gDAAgD;AAChD,KAAK,WAAW,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;AAEjE,qCAAqC;AACrC,UAAU,GAAG;IACX,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,WAAW,CAAC;IACnB,IAAI,EAAE,WAAW,CAAC;IAClB,IAAI,EAAE,WAAW,CAAC;IAClB,KAAK,EAAE,WAAW,CAAC;IACnB,KAAK,EAAE,WAAW,CAAC;IACnB,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;CAClC"}

package/dist/index.js

@@ -0,0 +1,124 @@
+import chalk from 'chalk';
+/**
+ * Main logging utility object providing color-coded console output at various log levels.
+ *
+ * @example
+ * ```typescript
+ * import { log } from '@paxtonterrydev/quicklog';
+ *
+ * log.info('Server started');
+ * log.warn('Deprecated API usage');
+ * log.error('Connection failed');
+ *
+ * // Enable timestamps
+ * log.timestamp = true;
+ * log.info('This message includes a timestamp');
+ * ```
+ */
+export const log = {
+    /**
+     * When true, prepends a timestamp to all log messages.
+     * @default false
+     */
+    timestamp: false,
+    /**
+     * Logs a debug message. Only outputs in non-production environments
+     * (when NODE_ENV is not set to 'production').
+     * @param message - The message to log
+     */
+    debug: function (message) {
+        if (isProduction())
+            return;
+        console.log(formatMessage({ level: "debug", message }));
+    },
+    /**
+     * Logs an informational message.
+     * @param message - The message to log
+     */
+    info: function (message) {
+        console.log(formatMessage({ level: "info", message }));
+    },
+    /**
+     * Logs a warning message.
+     * @param message - The message to log
+     */
+    warn: function (message) {
+        console.warn(formatMessage({ level: "warn", message }));
+    },
+    /**
+     * Logs an error message.
+     * @param message - The message to log
+     */
+    error: function (message) {
+        console.error(formatMessage({ level: "error", message }));
+    },
+    /**
+     * Logs a fatal error message and sets process.exitCode to 1.
+     * Use for unrecoverable errors that should terminate the application.
+     * @param message - The message to log
+     */
+    fatal: function (message) {
+        console.error(formatMessage({ level: "fatal", message }));
+        process.exitCode = 1;
+    },
+    /**
+     * Logs an object with full depth inspection.
+     * Useful for debugging complex nested objects.
+     * @param object - The object to log
+     */
+    object: (object) => {
+        console.dir(object, { depth: null });
+    }
+};
+/** Color mappings for each log level. */
+const colors = {
+    debug: {
+        level: chalk.green,
+        message: chalk.white,
+    },
+    info: {
+        level: chalk.blue,
+        message: chalk.white,
+    },
+    warn: {
+        level: chalk.yellow,
+        message: chalk.yellow,
+    },
+    error: {
+        level: chalk.red,
+        message: chalk.red,
+    },
+    fatal: {
+        level: chalk.bgRedBright,
+        message: chalk.bgRedBright,
+    },
+};
+/**
+ * Formats a log message with colors and optional timestamp.
+ * @param msg - The log message configuration
+ * @returns The formatted, colorized string ready for output
+ */
+function formatMessage(msg) {
+    const levelColor = colors[msg.level].level;
+    const messageColor = colors[msg.level].message;
+    const levelStr = `[${msg.level.toUpperCase()}]`;
+    return `${log.timestamp ? `${createTimestamp()} ` : ""}${levelColor(levelStr.padEnd(7, " "))} ${messageColor(msg.message)}`;
+}
+/**
+ * Creates a formatted timestamp string using the local date and time.
+ * @returns A timestamp in the format "[MM/DD/YYYY HH:MM:SS AM/PM]"
+ */
+function createTimestamp() {
+    const now = new Date();
+    const localDate = now.toLocaleDateString();
+    const localTime = now.toLocaleTimeString();
+    return `[${localDate} ${localTime}]`;
+}
+/**
+ * Checks if the current environment is production.
+ * @returns True if NODE_ENV is set to 'production'
+ */
+function isProduction() {
+    return process.env.NODE_ENV === 'production';
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,GAAG,GAAQ;IACtB;;;OAGG;IACH,SAAS,EAAE,KAAK;IAEhB;;;;OAIG;IACH,KAAK,EAAE,UAAS,OAAe;QAC7B,IAAI,YAAY,EAAE;YAAE,OAAO;QAC3B,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;IACzD,CAAC;IAED;;;OAGG;IACH,IAAI,EAAE,UAAS,OAAe;QAC5B,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;IACxD,CAAC;IAED;;;OAGG;IACH,IAAI,EAAE,UAAS,OAAe;QAC5B,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;IACzD,CAAC;IAED;;;OAGG;IACH,KAAK,EAAE,UAAS,OAAe;QAC7B,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;IAC3D,CAAC;IAED;;;;OAIG;IACH,KAAK,EAAE,UAAS,OAAe;QAC7B,OAAO,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;QACzD,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,MAAM,EAAE,CAAC,MAAc,EAAQ,EAAE;QAC/B,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;IACtC,CAAC;CACF,CAAA;AA4BD,yCAAyC;AACzC,MAAM,MAAM,GAAqC;IAC/C,KAAK,EAAE;QACL,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,OAAO,EAAE,KAAK,CAAC,KAAK;KACrB;IACD,IAAI,EAAE;QACJ,KAAK,EAAE,KAAK,CAAC,IAAI;QACjB,OAAO,EAAE,KAAK,CAAC,KAAK;KACrB;IACD,IAAI,EAAE;QACJ,KAAK,EAAE,KAAK,CAAC,MAAM;QACnB,OAAO,EAAE,KAAK,CAAC,MAAM;KACtB;IACD,KAAK,EAAE;QACL,KAAK,EAAE,KAAK,CAAC,GAAG;QAChB,OAAO,EAAE,KAAK,CAAC,GAAG;KACnB;IACD,KAAK,EAAE;QACL,KAAK,EAAE,KAAK,CAAC,WAAW;QACxB,OAAO,EAAE,KAAK,CAAC,WAAW;KAC3B;CACF,CAAA;AAQD;;;;GAIG;AACH,SAAS,aAAa,CAAC,GAAe;IACpC,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC;IAC3C,MAAM,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;IAE/C,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,WAAW,EAAE,GAAG,CAAA;IAC/C,OAAO,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,eAAe,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAA;AAC7H,CAAC;AAED;;;GAGG;AACH,SAAS,eAAe;IACtB,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;IACvB,MAAM,SAAS,GAAG,GAAG,CAAC,kBAAkB,EAAE,CAAC;IAC3C,MAAM,SAAS,GAAG,GAAG,CAAC,kBAAkB,EAAE,CAAC;IAC3C,OAAO,IAAI,SAAS,IAAI,SAAS,GAAG,CAAA;AACtC,CAAC;AAED;;;GAGG;AACH,SAAS,YAAY;IACnB,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,CAAC;AAC/C,CAAC"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@ptdlib/quicklog",
+  "version": "1.0.2",
+  "description": "Simple logging utility for typescript",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "dev": "tsx --watch src/index.ts",
+    "build": "tsc",
+    "prepare": "npm run build",
+    "pub": "npm publish --access=public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PaxtonTerryDev/quicklog.git"
+  },
+  "author": "PaxtonTerryDev",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/PaxtonTerryDev/quicklog/issues"
+  },
+  "homepage": "https://github.com/PaxtonTerryDev/quicklog#readme",
+  "devDependencies": {
+    "@types/node": "^25.0.9",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3"
+  },
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "dotenv": "^17.2.3"
+  }
+}