where-log 0.1.1 → 0.2.0

package/README.md

@@ -1,17 +1,17 @@
-# callsite-log
+# where-log
 
 Log a value with the caller file and line number.
 
 ## Install
 
 ```bash
-npm install callsite-log
+npm install where-log
 ```
 
 ## Usage
 
 ```ts
-import { log } from "callsite-log";
+import { log } from "where-log";
 
 const user = { id: 1, name: "Shovon" };
 log(user);
@@ -41,6 +41,8 @@ log("user", user, {
     valueLine: `${label}: ${JSON.stringify(value)}`,
   }),
 });
+
+log(user, { mode: "fast", includeLocation: false });
 ```
 
 ## Notes
@@ -49,11 +51,22 @@ log("user", user, {
 - Browser/Next.js: call-site depends on source maps and bundler/devtools behavior.
 - If stack parsing fails, the package prints `unknown:0` on line 1.
 
+## Performance Tuning
+
+- `mode: "pretty"` (default): rich formatting via Node inspect.
+- `mode: "fast"`: lower overhead formatting for hot paths.
+- `includeLocation: false`: skips stack capture/parsing.
+- `inspectDepth`: limit inspect depth in pretty mode.
+
 ## API
 
 - `log(value: unknown): void`
 - `log(value: unknown, options?: LogOptions): void`
 - `log(label: string, value: unknown, options?: LogOptions): void`
+- `LogMode = "pretty" | "fast"`
 - `LogOptions`
+  - `mode?: LogMode` (default `"pretty"`)
+  - `includeLocation?: boolean` (default `true`)
+  - `inspectDepth?: number` (pretty mode only)
   - `colors?: boolean` (Node only, default `true`)
   - `formatter?: (input) => { locationLine: unknown; valueLine: unknown }`

package/dist/index.cjs

@@ -34,18 +34,71 @@ __export(index_exports, {
   log: () => log
 });
 module.exports = __toCommonJS(index_exports);
+
+// src/core/format.ts
 var import_node_util = __toESM(require("util"), 1);
-var import_node_path = __toESM(require("path"), 1);
 function isNodeRuntime() {
   return typeof process !== "undefined" && !!process.versions?.node;
 }
+function safeFastStringify(value) {
+  const seen = /* @__PURE__ */ new WeakSet();
+  return JSON.stringify(value, (_k, v) => {
+    if (typeof v === "object" && v !== null) {
+      if (seen.has(v)) return "[Circular]";
+      seen.add(v);
+    }
+    return v;
+  });
+}
+function formatFastValue(value) {
+  if (typeof value === "string") return value;
+  if (typeof value === "number") return String(value);
+  if (typeof value === "boolean") return String(value);
+  if (typeof value === "bigint") return value.toString();
+  if (typeof value === "undefined") return "undefined";
+  if (value === null) return "null";
+  if (typeof value === "symbol") return value.toString();
+  if (typeof value === "function") {
+    return `[Function ${value.name || "anonymous"}]`;
+  }
+  try {
+    return safeFastStringify(value);
+  } catch {
+    return "[Unserializable]";
+  }
+}
+function formatValue(value, options) {
+  const mode = options?.mode ?? "pretty";
+  if (mode === "fast") {
+    return formatFastValue(value);
+  }
+  if (!isNodeRuntime()) {
+    return value;
+  }
+  return import_node_util.default.inspect(value, {
+    depth: options?.inspectDepth ?? null,
+    colors: options?.colors ?? true,
+    compact: false
+  });
+}
+function formatLabeledValue(label, formattedValue) {
+  if (!label) return formattedValue;
+  if (typeof formattedValue === "string") {
+    return `${label}: ${formattedValue}`;
+  }
+  return `${label}: ${String(formattedValue)}`;
+}
+
+// src/core/stack.ts
 function safeToInt(input) {
   const n = Number.parseInt(input, 10);
   return Number.isFinite(n) ? n : 0;
 }
-function normalizeFile(filePath) {
+function basename(filePath) {
   const clean = filePath.replace(/^file:\/\//, "");
-  return import_node_path.default.basename(clean);
+  const normalized = clean.replace(/\\/g, "/");
+  const last = normalized.lastIndexOf("/");
+  return last >= 0 ? normalized.slice(last + 1) : normalized;
 }
 function parseFrameLine(frame) {
   const cleaned = frame.trim();
@@ -53,14 +106,14 @@ function parseFrameLine(frame) {
   const v8Match = cleaned.match(/(?:at\s+)?(?:.+\s+\()?(.+):(\d+):(\d+)\)?$/);
   if (v8Match) {
     return {
-      file: normalizeFile(v8Match[1]),
+      file: basename(v8Match[1]),
       line: safeToInt(v8Match[2])
     };
   }
   const ffMatch = cleaned.match(/@(.+):(\d+):(\d+)$/);
   if (ffMatch) {
     return {
-      file: normalizeFile(ffMatch[1]),
+      file: basename(ffMatch[1]),
       line: safeToInt(ffMatch[2])
     };
   }
@@ -68,39 +121,28 @@ function parseFrameLine(frame) {
 }
 function getCallerFromStack(stack) {
   if (!stack) return { file: "unknown", line: 0 };
-  const frames = stack.split("\n").map((line) => line.trim()).filter(Boolean);
-  for (const frame of frames) {
+  const frames = stack.split("\n");
+  for (let i = 0; i < frames.length; i += 1) {
+    const frame = frames[i].trim();
+    if (!frame) continue;
     if (frame.includes("getCallerFromStack")) continue;
     if (frame.includes("at log")) continue;
     if (frame.includes("at Object.log")) continue;
     if (frame.includes("/src/index.ts")) continue;
     if (frame.includes("\\src\\index.ts")) continue;
+    if (frame.includes("/src/core/")) continue;
+    if (frame.includes("\\src\\core\\")) continue;
     const parsed = parseFrameLine(frame);
     if (parsed) return parsed;
   }
   return { file: "unknown", line: 0 };
 }
+
+// src/index.ts
 function isLogOptions(value) {
   if (!value || typeof value !== "object") return false;
   const record = value;
-  return "colors" in record || "formatter" in record;
-}
-function formatValue(value, options) {
-  if (!isNodeRuntime()) {
-    return value;
-  }
-  return import_node_util.default.inspect(value, {
-    depth: null,
-    colors: options?.colors ?? true,
-    compact: false
-  });
-}
-function formatLabeledValue(label, formattedValue) {
-  if (!label) return formattedValue;
-  if (typeof formattedValue === "string") {
-    return `${label}: ${formattedValue}`;
-  }
-  return `${label}: ${String(formattedValue)}`;
+  return "colors" in record || "formatter" in record || "mode" in record || "includeLocation" in record || "inspectDepth" in record;
 }
 function log(arg1, arg2, arg3) {
   let label;
@@ -114,10 +156,16 @@ function log(arg1, arg2, arg3) {
     value = arg1;
     options = isLogOptions(arg2) ? arg2 : void 0;
   }
-  const stack = new Error().stack;
-  const caller = getCallerFromStack(stack);
+  const includeLocation = options?.includeLocation ?? true;
+  const stack = includeLocation ? new Error().stack : void 0;
+  const caller = includeLocation ? getCallerFromStack(stack) : { file: "disabled", line: 0 };
   const location = `${caller.file}:${caller.line}`;
-  const formattedValue = formatValue(value, options);
+  const formatOptions = {
+    colors: options?.colors,
+    mode: options?.mode,
+    inspectDepth: options?.inspectDepth
+  };
+  const formattedValue = formatValue(value, formatOptions);
   if (options?.formatter) {
     const formatted = options.formatter({
       location,
@@ -129,7 +177,9 @@ function log(arg1, arg2, arg3) {
     console.log(formatted.valueLine);
     return;
   }
-  console.log(location);
+  if (includeLocation) {
+    console.log(location);
+  }
   console.log(formatLabeledValue(label, formattedValue));
 }
 var __internal = {

package/dist/index.d.cts

@@ -1,7 +1,13 @@
+type LogMode = "pretty" | "fast";
+declare function formatLabeledValue(label: string | undefined, formattedValue: unknown): unknown;
+
 type ParsedFrame = {
     file: string;
     line: number;
 };
+declare function parseFrameLine(frame: string): ParsedFrame | null;
+declare function getCallerFromStack(stack?: string): ParsedFrame;
+
 type FormatterInput = {
     location: string;
     label?: string;
@@ -13,13 +19,13 @@ type FormatterOutput = {
     valueLine: unknown;
 };
 type LogOptions = {
+    mode?: LogMode;
+    includeLocation?: boolean;
+    inspectDepth?: number;
     colors?: boolean;
     formatter?: (input: FormatterInput) => FormatterOutput;
 };
-declare function parseFrameLine(frame: string): ParsedFrame | null;
-declare function getCallerFromStack(stack?: string): ParsedFrame;
 declare function isLogOptions(value: unknown): value is LogOptions;
-declare function formatLabeledValue(label: string | undefined, formattedValue: unknown): unknown;
 declare function log(value: unknown, options?: LogOptions): void;
 declare function log(label: string, value: unknown, options?: LogOptions): void;
 declare const __internal: {
@@ -29,4 +35,4 @@ declare const __internal: {
     isLogOptions: typeof isLogOptions;
 };
 
-export { type FormatterInput, type FormatterOutput, type LogOptions, __internal, log };
+export { type FormatterInput, type FormatterOutput, type LogMode, type LogOptions, __internal, log };

package/dist/index.d.ts

@@ -1,7 +1,13 @@
+type LogMode = "pretty" | "fast";
+declare function formatLabeledValue(label: string | undefined, formattedValue: unknown): unknown;
+
 type ParsedFrame = {
     file: string;
     line: number;
 };
+declare function parseFrameLine(frame: string): ParsedFrame | null;
+declare function getCallerFromStack(stack?: string): ParsedFrame;
+
 type FormatterInput = {
     location: string;
     label?: string;
@@ -13,13 +19,13 @@ type FormatterOutput = {
     valueLine: unknown;
 };
 type LogOptions = {
+    mode?: LogMode;
+    includeLocation?: boolean;
+    inspectDepth?: number;
     colors?: boolean;
     formatter?: (input: FormatterInput) => FormatterOutput;
 };
-declare function parseFrameLine(frame: string): ParsedFrame | null;
-declare function getCallerFromStack(stack?: string): ParsedFrame;
 declare function isLogOptions(value: unknown): value is LogOptions;
-declare function formatLabeledValue(label: string | undefined, formattedValue: unknown): unknown;
 declare function log(value: unknown, options?: LogOptions): void;
 declare function log(label: string, value: unknown, options?: LogOptions): void;
 declare const __internal: {
@@ -29,4 +35,4 @@ declare const __internal: {
     isLogOptions: typeof isLogOptions;
 };
 
-export { type FormatterInput, type FormatterOutput, type LogOptions, __internal, log };
+export { type FormatterInput, type FormatterOutput, type LogMode, type LogOptions, __internal, log };

package/dist/index.mjs

@@ -1,16 +1,67 @@
-// src/index.ts
+// src/core/format.ts
 import util from "util";
-import path from "path";
 function isNodeRuntime() {
   return typeof process !== "undefined" && !!process.versions?.node;
 }
+function safeFastStringify(value) {
+  const seen = /* @__PURE__ */ new WeakSet();
+  return JSON.stringify(value, (_k, v) => {
+    if (typeof v === "object" && v !== null) {
+      if (seen.has(v)) return "[Circular]";
+      seen.add(v);
+    }
+    return v;
+  });
+}
+function formatFastValue(value) {
+  if (typeof value === "string") return value;
+  if (typeof value === "number") return String(value);
+  if (typeof value === "boolean") return String(value);
+  if (typeof value === "bigint") return value.toString();
+  if (typeof value === "undefined") return "undefined";
+  if (value === null) return "null";
+  if (typeof value === "symbol") return value.toString();
+  if (typeof value === "function") {
+    return `[Function ${value.name || "anonymous"}]`;
+  }
+  try {
+    return safeFastStringify(value);
+  } catch {
+    return "[Unserializable]";
+  }
+}
+function formatValue(value, options) {
+  const mode = options?.mode ?? "pretty";
+  if (mode === "fast") {
+    return formatFastValue(value);
+  }
+  if (!isNodeRuntime()) {
+    return value;
+  }
+  return util.inspect(value, {
+    depth: options?.inspectDepth ?? null,
+    colors: options?.colors ?? true,
+    compact: false
+  });
+}
+function formatLabeledValue(label, formattedValue) {
+  if (!label) return formattedValue;
+  if (typeof formattedValue === "string") {
+    return `${label}: ${formattedValue}`;
+  }
+  return `${label}: ${String(formattedValue)}`;
+}
+
+// src/core/stack.ts
 function safeToInt(input) {
   const n = Number.parseInt(input, 10);
   return Number.isFinite(n) ? n : 0;
 }
-function normalizeFile(filePath) {
+function basename(filePath) {
   const clean = filePath.replace(/^file:\/\//, "");
-  return path.basename(clean);
+  const normalized = clean.replace(/\\/g, "/");
+  const last = normalized.lastIndexOf("/");
+  return last >= 0 ? normalized.slice(last + 1) : normalized;
 }
 function parseFrameLine(frame) {
   const cleaned = frame.trim();
@@ -18,14 +69,14 @@ function parseFrameLine(frame) {
   const v8Match = cleaned.match(/(?:at\s+)?(?:.+\s+\()?(.+):(\d+):(\d+)\)?$/);
   if (v8Match) {
     return {
-      file: normalizeFile(v8Match[1]),
+      file: basename(v8Match[1]),
       line: safeToInt(v8Match[2])
     };
   }
   const ffMatch = cleaned.match(/@(.+):(\d+):(\d+)$/);
   if (ffMatch) {
     return {
-      file: normalizeFile(ffMatch[1]),
+      file: basename(ffMatch[1]),
       line: safeToInt(ffMatch[2])
     };
   }
@@ -33,39 +84,28 @@ function parseFrameLine(frame) {
 }
 function getCallerFromStack(stack) {
   if (!stack) return { file: "unknown", line: 0 };
-  const frames = stack.split("\n").map((line) => line.trim()).filter(Boolean);
-  for (const frame of frames) {
+  const frames = stack.split("\n");
+  for (let i = 0; i < frames.length; i += 1) {
+    const frame = frames[i].trim();
+    if (!frame) continue;
     if (frame.includes("getCallerFromStack")) continue;
     if (frame.includes("at log")) continue;
     if (frame.includes("at Object.log")) continue;
     if (frame.includes("/src/index.ts")) continue;
     if (frame.includes("\\src\\index.ts")) continue;
+    if (frame.includes("/src/core/")) continue;
+    if (frame.includes("\\src\\core\\")) continue;
     const parsed = parseFrameLine(frame);
     if (parsed) return parsed;
   }
   return { file: "unknown", line: 0 };
 }
+
+// src/index.ts
 function isLogOptions(value) {
   if (!value || typeof value !== "object") return false;
   const record = value;
-  return "colors" in record || "formatter" in record;
-}
-function formatValue(value, options) {
-  if (!isNodeRuntime()) {
-    return value;
-  }
-  return util.inspect(value, {
-    depth: null,
-    colors: options?.colors ?? true,
-    compact: false
-  });
-}
-function formatLabeledValue(label, formattedValue) {
-  if (!label) return formattedValue;
-  if (typeof formattedValue === "string") {
-    return `${label}: ${formattedValue}`;
-  }
-  return `${label}: ${String(formattedValue)}`;
+  return "colors" in record || "formatter" in record || "mode" in record || "includeLocation" in record || "inspectDepth" in record;
 }
 function log(arg1, arg2, arg3) {
   let label;
@@ -79,10 +119,16 @@ function log(arg1, arg2, arg3) {
     value = arg1;
     options = isLogOptions(arg2) ? arg2 : void 0;
   }
-  const stack = new Error().stack;
-  const caller = getCallerFromStack(stack);
+  const includeLocation = options?.includeLocation ?? true;
+  const stack = includeLocation ? new Error().stack : void 0;
+  const caller = includeLocation ? getCallerFromStack(stack) : { file: "disabled", line: 0 };
   const location = `${caller.file}:${caller.line}`;
-  const formattedValue = formatValue(value, options);
+  const formatOptions = {
+    colors: options?.colors,
+    mode: options?.mode,
+    inspectDepth: options?.inspectDepth
+  };
+  const formattedValue = formatValue(value, formatOptions);
   if (options?.formatter) {
     const formatted = options.formatter({
       location,
@@ -94,7 +140,9 @@ function log(arg1, arg2, arg3) {
     console.log(formatted.valueLine);
     return;
   }
-  console.log(location);
+  if (includeLocation) {
+    console.log(location);
+  }
   console.log(formatLabeledValue(label, formattedValue));
 }
 var __internal = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "where-log",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Log values with caller file and line number.",
   "license": "MIT",
   "private": false,
@@ -24,6 +24,8 @@
     "typecheck": "tsc --noEmit",
     "test": "vitest run --pool=threads",
     "dev": "vitest --pool=threads",
+    "bench": "node bench/run-bench.mjs",
+    "bench:ci": "node bench/run-bench.mjs --ci",
     "pack:dry-run": "npm pack --dry-run --cache ./.npm-cache",
     "publish:dry-run": "npm publish --dry-run --cache ./.npm-cache",
     "release:check": "npm run pack:dry-run && npm run publish:dry-run"
@@ -43,4 +45,4 @@
     "typescript": "^5.5.4",
     "vitest": "^2.0.5"
   }
-}
+}