use-term 1.1.0 → 2.1.0

package/README.md

@@ -35,6 +35,57 @@ npm install use-term
 
 ---
 
+## ⚙️ Configuration
+
+You can customize the logger behavior by passing options when creating a new instance:
+
+```javascript
+import { Logger } from "use-term";
+
+// Disable all logs (useful for testing or production overrides)
+const silentLogger = new Logger({ silent: true });
+silentLogger.info("This won't be logged");
+
+// Disable logs in specific environments (defaults to ["production"])
+const logger = new Logger({
+  silentEnvironments: ["production", "staging"],
+  environment: process.env.NODE_ENV,
+});
+
+// Custom configuration
+const customLogger = new Logger({
+  silent: false,
+  silentEnvironments: ["prod"],
+  environment: process.env.APP_ENV || "development",
+});
+```
+
+### Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `silent` | boolean | `false` | If `true`, all logs are disabled |
+| `silentEnvironments` | string[] | `["production"]` | Array of environments where logging is disabled |
+| `environment` | string | `process.env.NODE_ENV \|\| "development"` | Current environment name |
+
+**Example: Disable logs only in production**
+
+```javascript
+const logger = new Logger(); // By default, logs are disabled when NODE_ENV=production
+logger.info("This won't appear in production"); // Silent in production
+```
+
+**Example: Disable logs in multiple environments**
+
+```javascript
+const logger = new Logger({
+  silentEnvironments: ["production", "staging", "testing"],
+});
+// Logs will be silenced in any of these environments
+```
+
+---
+
 ## 🚀 Usage
 
 Since `use-term` is built with universal Node.js compatibility in mind, it works seamlessly in both modern **ES Modules (ESM)** and legacy **CommonJS** environments out-of-the-box without requiring separate bundles or transpilation.
@@ -44,26 +95,36 @@ Since `use-term` is built with universal Node.js compatibility in mind, it works
 For modern Node.js environments (projects with `"type": "module"` in `package.json`), TypeScript, Next.js, or Vite:
 
 ```javascript
-import term from "use-term";
+import { Logger } from "use-term";
+
+// Create a logger instance with default options
+// Logs are disabled in production by default
+const logger = new Logger();
+
+// For custom environments:
+const customLogger = new Logger({
+  environment: process.env.NODE_ENV,
+  silentEnvironments: ["production", "staging"],
+});
 
 // --- A. Using inside a class (automatically gets class name) ---
 class AuthService {
   login() {
-    term.info("Starting login process...", undefined, this);
+    logger.info("Starting login process...", undefined, this);
 
     const user = { id: 42, name: "Alex", roles: ["admin", "billing"] };
-    term.success("Credentials validated successfully", user, this);
+    logger.success("Credentials validated successfully", user, this);
   }
 }
 
 // --- B. Using inside a function (automatically gets function name) ---
 function processPayment() {
-  term.warn(
+  logger.warn(
     "Payment gateway is responding slowly",
     { delayMs: 1500 },
     processPayment,
   );
-  term.error(
+  logger.error(
     "Payment gateway connection timeout",
     { code: "ETIMEDOUT" },
     processPayment,
@@ -71,14 +132,14 @@ function processPayment() {
 }
 
 // --- C. Using custom string scopes ---
-term.info("Server initialized on port 3000", { env: "production" }, "Server");
+logger.info("Server initialized on port 3000", { env: "production" }, "Server");
 
 // --- D. Visual titles ---
-term.title("Authentication Flow");
+logger.title("Authentication Flow");
 const auth = new AuthService();
 auth.login();
 
-term.title("Payment Flow");
+logger.title("Payment Flow");
 processPayment();
 ```
 
@@ -89,20 +150,30 @@ processPayment();
 For traditional Node.js applications:
 
 ```javascript
-const term = require("use-term");
+const { Logger } = require("use-term");
+
+// Create a logger instance with default options
+// Logs are disabled in production by default
+const logger = new Logger();
+
+// For custom environments:
+const customLogger = new Logger({
+  environment: process.env.NODE_ENV,
+  silentEnvironments: ["prod"],
+});
 
 // Easily log with CommonJS:
-term.info("Logging using standard require() syntax!", undefined, "CJS");
+logger.info("Logging using standard require() syntax!", undefined, "CJS");
 
 class AuthService {
   login() {
-    term.info("Starting login process...", undefined, this);
+    logger.info("Starting login process...", undefined, this);
     const user = { id: 42, name: "Alex", roles: ["admin", "billing"] };
-    term.success("Credentials validated successfully", user, this);
+    logger.success("Credentials validated successfully", user, this);
   }
 }
 
-term.title("CommonJS Demo");
+logger.title("CommonJS Demo");
 const auth = new AuthService();
 auth.login();
 ```
@@ -133,7 +204,7 @@ When you run your scripts, your terminal will light up with premium, high-visibi
 
 ## 🛠️ API Reference
 
-### `term.info(message, [data], [context])`
+### `logger.info(message, [data], [context])`
 
 Logs an informational message.
 
@@ -141,19 +212,19 @@ Logs an informational message.
 - `data` `(any, optional)`: Any object, array, or metadata to inspect and format below.
 - `context` `(any, optional)`: `this` inside a class, a function name, or a plain string.
 
-### `term.error(message, [data], [context])`
+### `logger.error(message, [data], [context])`
 
 Logs an error message. Same signature as `info()`.
 
-### `term.success(message, [data], [context])`
+### `logger.success(message, [data], [context])`
 
 Logs a success message. Same signature as `info()`.
 
-### `term.warn(message, [data], [context])`
+### `logger.warn(message, [data], [context])`
 
 Logs a warning message. Same signature as `info()`.
 
-### `term.title(message)`
+### `logger.title(message)`
 
 Prints a highlighted, uppercase section divider to demarcate different stages in your runtime.
 
@@ -166,9 +237,11 @@ Prints a highlighted, uppercase section divider to demarcate different stages in
 Autocompletion works out of the box in VS Code and modern IDEs. If you are using TypeScript:
 
 ```typescript
-import term from "use-term";
+import { Logger } from "use-term";
+
+const logger = new Logger();
 
-term.info("Fully typed logger out of the box!", undefined, "TypeScript");
+logger.info("Fully typed logger out of the box!", undefined, "TypeScript");
 ```
 
 ---

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "use-term",
-  "version": "1.1.0",
+  "version": "2.1.0",
   "description": "A zero-dependency, ultra-lightweight, and beautiful terminal logging library for Node.js with smart context detection, colored outputs, and automatic timestamps.",
   "main": "src/term.js",
   "types": "src/term.d.ts",
@@ -37,5 +37,8 @@
   "license": "MIT",
   "engines": {
     "node": ">=12.0.0"
+  },
+  "scripts": {
+    "test": "node test/test.js"
   }
 }

package/src/term.d.ts

@@ -1,7 +1,43 @@
+/**
+ * Configuration options for the Logger.
+ */
+export interface LoggerOptions {
+  /**
+   * If true, no logs will be printed regardless of environment.
+   * @default false
+   */
+  silent?: boolean;
+  /**
+   * Array of environments where logging should be disabled.
+   * @default ["production"]
+   */
+  silentEnvironments?: string[];
+  /**
+   * Current environment (defaults to NODE_ENV or "development").
+   * @default process.env.NODE_ENV || "development"
+   */
+  environment?: string;
+}
+
 /**
  * A beautiful, simple, and dependency-free terminal logger for Node.js.
+ * Instantiate with `new Logger()` to create a logger instance with optional configuration.
+ *
+ * @example
+ * const logger = new Logger();
+ * logger.info("Hello world");
+ *
+ * @example
+ * const logger = new Logger({ silent: true });
+ * logger.info("This won't be logged");
+ *
+ * @example
+ * const logger = new Logger({ silentEnvironments: ["production", "staging"] });
+ * // Logs will be disabled if NODE_ENV is "production" or "staging"
  */
-declare class Term {
+export class Logger {
+  constructor(options?: LoggerOptions);
+
   /**
    * Logs an informational message.
    * @param msg The message to log.
@@ -44,6 +80,3 @@ declare class Term {
    */
   title(msg: string): void;
 }
-
-declare const term: Term;
-export = term;

package/src/term.js

@@ -1,5 +1,11 @@
 const util = require("util");
 
+const DEFAULT_OPTIONS = {
+  silent: false,
+  silentEnvironments: ["production"],
+  environment: process.env.NODE_ENV || "development",
+};
+
 const COLORS = {
   info: "\x1b[36m",
   error: "\x1b[31m",
@@ -12,7 +18,22 @@ const COLORS = {
   bold: "\x1b[1m",
 };
 
-class Term {
+class Logger {
+  constructor(options = {}) {
+    this.config = {
+      ...DEFAULT_OPTIONS,
+      ...options,
+    };
+  }
+
+  _shouldLog() {
+    if (this.config.silent) return false;
+    if (this.config.silentEnvironments.includes(this.config.environment)) {
+      return false;
+    }
+    return true;
+  }
+
   _timestamp() {
     const now = new Date();
     const time = `${now.getHours().toString().padStart(2, "0")}:${now.getMinutes().toString().padStart(2, "0")}:${now.getSeconds().toString().padStart(2, "0")}`;
@@ -46,6 +67,8 @@ class Term {
   }
 
   _log(type, color, icon, context, msg, data) {
+    if (!this._shouldLog()) return;
+
     const ctxName = this._getContextName(context);
     const timestamp = this._timestamp();
     const tag = `${color}${icon} ${type}${COLORS.reset}`;
@@ -100,10 +123,14 @@ class Term {
   }
 
   title(msg) {
+    if (!this._shouldLog()) return;
+
     console.log(
       `\n${COLORS.magenta}${COLORS.bold}━━━ ${msg.toUpperCase()} ━━━${COLORS.reset}`,
     );
   }
 }
 
-module.exports = new Term();
+module.exports = Logger;
+module.exports.Logger = Logger;
+module.exports.default = Logger;