@meadown/logger 1.8.6 → 1.8.8

package/README.md

@@ -2,7 +2,7 @@
 
 # @meadown/logger
 
-A **development-focused logger** for Node.js and TypeScript — built to make your
+A **development-focused logger** for Node.js and TypeScript. Built to make your
 development loop faster and your terminal actually readable.
 
 No dependencies. No config. Import it and you're done.
@@ -10,7 +10,7 @@ No dependencies. No config. Import it and you're done.
 ## Why this exists
 
 I kept writing the same `console.log` wrapper in every project. Every time.
-Copy, paste, rename. And I still shipped it to production by accident. And I
+Copy, paste, rename. And I still shipped it to production by accident. Unconsciously I
 still spent ten minutes staring at logs trying to figure out which file they
 came from.
 
@@ -19,6 +19,10 @@ At some point I just built the thing I always wanted.
 One import. No config. No dependencies. It shows you exactly where every log
 came from, and it gets out of the way when you ship.
 
+It's not trying to be Winston or Pino. No transports, no log levels, no config files.
+Just a better `console.log` for the hours you spend in development. One that
+tells you where things came from and disappears when you ship.
+
 > The full story — the problem, the research, every design decision, and
 > everything that got cut — is in [`docs/STORY.md`](docs/STORY.md).
 
@@ -27,7 +31,7 @@ came from, and it gets out of the way when you ship.
 - **Zero dependencies**
 - **Development-focused** — built for the dev experience, not production ops
 - **Clickable source link** — every log is a clickable link to the exact file it came from
-- **API response logging** — `tap` a fetch and get timing, status, size, and body automatically
+- **Tap logging** — log any value or promise inline; fetch calls also get timing, status, size, and body
 - **Color-coded levels** — `[INFO]` cyan, `[WARN]` yellow, `[ERROR]` red
 - **Tree layout output** — clean, scannable structure in your terminal
 - **Collapsible messages** — cap long output with `logger.maxLines`
@@ -44,6 +48,9 @@ yarn add @meadown/logger
 
 ## Using it
 
+Set `NODE_ENV=production` and all output is suppressed. Anything else and
+logging is on. No config files, no init call, no options object.
+
 ```ts
 import logger from "@meadown/logger"
 
@@ -60,9 +67,41 @@ logger.error("Something went wrong")
 └── 05-30 04:00:00 PM - (server.ts:42)
 ```
 
+### Recommended: single shared import
+
+Rather than importing directly from `@meadown/logger` in every file, create
+one shared module in your project and re-export from there. This gives you a
+single place to set options like `maxLines` and keeps any future changes to
+one file.
+
+```ts
+// lib/logger.ts
+import logger from "@meadown/logger"
+
+logger.maxLines = 10 // configure once, applies everywhere
+
+export default logger
+```
+
+```ts
+// anywhere else in your project
+import logger from "@/lib/logger"
+```
+
+When re-exporting, use a direct re-export, Not a wrapper function. A wrapper
+breaks the caller location shown in every log line.
+
+```ts
+// GOOD — location stays honest
+export { default as logger } from "@meadown/logger"
+
+// BAD — every log points at this file, not the real caller
+export const logger = (...args) => log(...args)
+```
+
 ## API response logging
 
-Drop `tap` into any `await` chain — you get timing, status, size, and the
+Drop `tap` into any `await` chain. You get timing, status, size, and the
 actual response body. The promise flows through untouched. One line of code.
 
 ```ts
@@ -93,25 +132,45 @@ const user = await logger.tap(
 You can immediately see: was it successful? How long did it take? What came
 back? Without opening DevTools.
 
-![API response logging — tap a fetch and see timing, status, size, and body](media/tap-api-demo.png)
+![API response logging: tap a fetch and see timing, status, size, and body](media/tap-api-demo.png)
+
+### Tap any value
+
+`tap` works on anything, not just fetch. Pass in any value or expression and
+get it back exactly as it was. The only thing that happens is a log.
+
+```ts
+// numbers, strings, objects — logged and returned as-is
+logger.tap(port, "port")
+logger.tap(process.env.NODE_ENV, "env")
+logger.tap(config, "loaded config")
+```
 
-Works with plain values too — logs it, returns it, nothing changes:
+```ts
+// async functions — promise flows through, timing logged when it settles
+const user = await logger.tap(getUser(), "getUser")
+const config = await logger.tap(loadConfig(), "loadConfig")
+```
 
 ```ts
-const port = logger.tap(5000, "port") // port is still 5000
-const user = logger.tap(await getUser(), "user") // same as without tap
+// inline — no temp variable needed
+server.listen(logger.tap(port, "port"))
 ```
 
+If it's a promise, `tap` logs elapsed time once it settles. If it resolves
+to a `Response` (any fetch like call), you also get status and size, same
+as the fetch example above.
+
 ## Clickable source link
 
-That `(server.ts:42)` is a **clickable link** — open it and you land on the exact
-line that wrote the log. Works in VS Code, iTerm2, WezTerm, Kitty, and Windows
-Terminal. Degrades to plain text everywhere else.
+That `(server.ts:42)` is a **clickable link**. Click it and the file opens.
+The line number is right there so you can jump straight to it. Works in VS Code,
+iTerm2, WezTerm, Kitty, and Windows Terminal. Degrades to plain text everywhere else.
 
 ## Color-coded levels
 
-`[INFO]` cyan · `[WARN]` yellow · `[ERROR]` red. Timestamp and location tinted teal.
-Auto-disabled when output is piped — no escape codes in your log files.
+`[INFO]` , `[TAP]` cyan · `[WARN]` yellow · `[ERROR]` red. Timestamp and location tinted teal.
+Auto-disabled when output is piped no escape codes in your log files.
 
 ## Tree layout output
 
@@ -121,7 +180,7 @@ Auto-disabled when output is piped — no escape codes in your log files.
 └── 05-30 04:00:00 PM - (server.ts:42)
 ```
 
-Level tag, message, timestamp, and location — all in a clean tree. Easy to scan,
+Level tag, message, timestamp, and location all in a clean tree. Easy to scan,
 even in a busy terminal.
 
 ## Collapsible messages
@@ -131,34 +190,25 @@ logger.maxLines = 5 // show 5 lines, then "... N more lines"
 logger.maxLines = 0 // default — show everything
 ```
 
-### One thing if you re-export it
-
-```ts
-// GOOD — location stays honest
-export { default as logger } from "@meadown/logger"
-
-// BAD — every log points at this file, not the real caller
-export const logger = (...args) => log(...args)
-```
-
 ## NODE_ENV
 
-This logger reads `NODE_ENV` to decide when to log. By default it logs everywhere
-except `production`. This is a deliberate dev-focused default — a production-grade
-logger with transport, persistence, and log levels is a separate concern and a
-future direction.
+You shouldn't have to think about whether your logs will leak into production.
+This package reads `NODE_ENV` and handles it for you. Set it to `production`
+and all output is handled for you. You never have to remember to wrap a log call,
+remove a debug line, or grep the codebase before a release.
 
-| `NODE_ENV`                               | Logs?  |
-| ---------------------------------------- | ------ |
-| not set, `development`, or anything else | shown  |
-| `production`                             | silent |
+| `NODE_ENV`                               | Logs?      |
+| ---------------------------------------- | ---------- |
+| not set, `development`, or anything else | shown      |
+| `production`                             | suppressed |
 
 ## Security
 
 Zero dependencies, no file or network access, nothing persisted.
-See [SECURITY.md](https://github.com/meadown/meadown-logger/blob/main/SECURITY.md)
-for the full security model.
+See [SECURITY.md](https://github.com/meadown/meadown-logger/blob/main/SECURITY.md) for the full security model.
 
 ## License
 
-MIT © meadown
+Architected and developed by [Dewan Mobashirul](https://linkedin.com/in/dewan-meadown)
+
+MIT © [meadown](https://github.com/meadown)

package/dist/caller/getCaller.js

@@ -23,10 +23,10 @@ export default function getCaller() {
     // Split off the trailing `:line:column`, keeping the (possibly colon-bearing)
     // path intact (e.g. Windows `C:\…` or `file://…`).
     const match = inner.match(/^(.*):(\d+):\d+$/);
-    const file = match?.[1];
-    if (file === undefined)
+    if (match === null)
         return UNKNOWN;
-    const line = Number(match?.[2]);
+    const file = match[1] ?? "";
+    const line = Number(match[2]);
     const base = file.split(/[/\\]/).pop() ?? "";
     if (!SOURCE_FILE.test(base))
         return UNKNOWN;

package/dist/cjs/caller/getCaller.js

@@ -26,10 +26,10 @@ function getCaller() {
     // Split off the trailing `:line:column`, keeping the (possibly colon-bearing)
     // path intact (e.g. Windows `C:\…` or `file://…`).
     const match = inner.match(/^(.*):(\d+):\d+$/);
-    const file = match?.[1];
-    if (file === undefined)
+    if (match === null)
         return UNKNOWN;
-    const line = Number(match?.[2]);
+    const file = match[1] ?? "";
+    const line = Number(match[2]);
     const base = file.split(/[/\\]/).pop() ?? "";
     if (!SOURCE_FILE.test(base))
         return UNKNOWN;

package/dist/cjs/constants.d.ts

@@ -9,6 +9,6 @@ export declare const BRANCH_END = "\u2514\u2500\u2500";
 export declare const SEPARATOR = "-";
 /** Hang-indent for message continuation lines, so they align under the message
  * text (the `├── ` branch is 4 columns wide). */
-export declare const MESSAGE_INDENT = "|\t";
+export declare const MESSAGE_INDENT = "\u2502   ";
 /** Default for the collapse setting: 0 = show every line. */
 export declare const DEFAULT_MAX_LINES = 0;

package/dist/cjs/constants.js

@@ -22,6 +22,6 @@ exports.BRANCH_END = "└──"; // the last (metadata) branch
 exports.SEPARATOR = "-"; // between the timestamp and the location
 /** Hang-indent for message continuation lines, so they align under the message
  * text (the `├── ` branch is 4 columns wide). */
-exports.MESSAGE_INDENT = "|\t";
+exports.MESSAGE_INDENT = "│   ";
 /** Default for the collapse setting: 0 = show every line. */
 exports.DEFAULT_MAX_LINES = 0;

package/dist/cjs/core/writeLog.js

@@ -76,17 +76,14 @@ function writeLog(opts) {
     // One terminal check drives both color and clickable links — `isTTY` is the
     // single source of truth (DRY). Off when output is piped/redirected.
     const useColor = (0, isTTY_js_1.isTTY)(streamName);
+    const paint = (s, c) => useColor ? (0, color_js_1.colorize)(s, c) : s;
     const location = formatLocation(caller, useColor);
-    // Colors (terminal only): tag by level, timestamp teal, location dim teal,
-    // branch and separator gray.
-    const tagOut = useColor ? (0, color_js_1.colorize)(tag, constants_js_1.TAG_COLOR[channel]) : tag;
-    const timeStamp = useColor ? (0, color_js_1.colorize)((0, getTimeStamp_js_1.default)(), "teal") : (0, getTimeStamp_js_1.default)();
-    const locOut = useColor
-        ? (0, color_js_1.colorize)(`(${location})`, "dimTeal")
-        : `(${location})`;
-    const connector = useColor ? (0, color_js_1.colorize)(constants_js_1.BRANCH, "gray") : constants_js_1.BRANCH;
-    const connectorBottom = useColor ? (0, color_js_1.colorize)(constants_js_1.BRANCH_END, "gray") : constants_js_1.BRANCH_END;
-    const separator = useColor ? (0, color_js_1.colorize)(constants_js_1.SEPARATOR, "gray") : constants_js_1.SEPARATOR;
+    const tagOut = paint(tag, constants_js_1.TAG_COLOR[channel]);
+    const timeStamp = paint((0, getTimeStamp_js_1.default)(), "teal");
+    const locOut = paint(`(${location})`, "dimTeal");
+    const connector = paint(constants_js_1.BRANCH, "gray");
+    const connectorBottom = paint(constants_js_1.BRANCH_END, "gray");
+    const separator = paint(constants_js_1.SEPARATOR, "gray");
     // Layout: the tag, the message hanging off a `├──` branch, then the timestamp
     // and location on a `└──` branch below. Leading `\n` spaces entries apart.
     const message = renderMessage(args, useColor);

package/dist/cjs/tap/tapAsync.js

@@ -106,23 +106,18 @@ async function readBody(res) {
  *   │  └── name:  Leanne Graham
  */
 function buildBlock(label, ms, res, body, useColor) {
-    const pipe = useColor ? (0, color_js_1.colorize)("│", "gray") : "│";
-    const branch = useColor ? (0, color_js_1.colorize)("├──", "gray") : "├──";
-    const last = useColor ? (0, color_js_1.colorize)("└──", "gray") : "└──";
+    const paint = (s, c) => useColor ? (0, color_js_1.colorize)(s, c) : s;
+    const pipe = paint("│", "gray");
+    const branch = paint("├──", "gray");
+    const last = paint("└──", "gray");
     const indent = `${pipe}  `;
-    const statusLine = `${indent}${branch} status: ${formatStatus(res, useColor)}`;
     const timeLine = `${indent}${branch} time:   ${formatDuration(ms, useColor)}`;
+    const statusLine = `${indent}${branch} status: ${formatStatus(res, useColor)}`;
     const sizeLine = `${indent}${last} size:   ${body.size}`;
-    const responseBlock = [
-        `${pipe}`,
-        `${indent}response:`,
-        timeLine,
-        statusLine,
-        sizeLine,
-    ].join("\n");
+    const responseLines = [`${pipe}`, `${indent}response:`, timeLine, statusLine, sizeLine];
+    const head = label === undefined ? "" : `${label}\n`;
     if (body.data === undefined) {
-        const head = label === undefined ? "" : `${label}\n`;
-        return [`${head}${responseBlock}`];
+        return [`${head}${responseLines.join("\n")}`];
     }
     // Render the body using util.formatWithOptions so objects/arrays look like
     // console.log output — colors, proper nesting, no JSON.stringify quirkiness.
@@ -132,17 +127,7 @@ function buildBlock(label, ms, res, body, useColor) {
     const bodyBlock = bodyLines
         .map((line, i) => `${indent}${i === lastIdx ? last : branch} ${line}`)
         .join("\n");
-    const full = [
-        `${pipe}`,
-        `${indent}response:`,
-        timeLine,
-        statusLine,
-        sizeLine,
-        `${pipe}`,
-        `${indent}body:`,
-        bodyBlock,
-    ].join("\n");
-    const head = label === undefined ? "" : `${label}\n`;
+    const full = [...responseLines, `${pipe}`, `${indent}body:`, bodyBlock].join("\n");
     return [`${head}${full}`];
 }
 /**

package/dist/constants.d.ts

@@ -9,6 +9,6 @@ export declare const BRANCH_END = "\u2514\u2500\u2500";
 export declare const SEPARATOR = "-";
 /** Hang-indent for message continuation lines, so they align under the message
  * text (the `├── ` branch is 4 columns wide). */
-export declare const MESSAGE_INDENT = "|\t";
+export declare const MESSAGE_INDENT = "\u2502   ";
 /** Default for the collapse setting: 0 = show every line. */
 export declare const DEFAULT_MAX_LINES = 0;

package/dist/constants.js

@@ -19,6 +19,6 @@ export const BRANCH_END = "└──"; // the last (metadata) branch
 export const SEPARATOR = "-"; // between the timestamp and the location
 /** Hang-indent for message continuation lines, so they align under the message
  * text (the `├── ` branch is 4 columns wide). */
-export const MESSAGE_INDENT = "|\t";
+export const MESSAGE_INDENT = "│   ";
 /** Default for the collapse setting: 0 = show every line. */
 export const DEFAULT_MAX_LINES = 0;

package/dist/core/writeLog.js

@@ -68,17 +68,14 @@ export function writeLog(opts) {
     // One terminal check drives both color and clickable links — `isTTY` is the
     // single source of truth (DRY). Off when output is piped/redirected.
     const useColor = isTTY(streamName);
+    const paint = (s, c) => useColor ? colorize(s, c) : s;
     const location = formatLocation(caller, useColor);
-    // Colors (terminal only): tag by level, timestamp teal, location dim teal,
-    // branch and separator gray.
-    const tagOut = useColor ? colorize(tag, TAG_COLOR[channel]) : tag;
-    const timeStamp = useColor ? colorize(getTimeStamp(), "teal") : getTimeStamp();
-    const locOut = useColor
-        ? colorize(`(${location})`, "dimTeal")
-        : `(${location})`;
-    const connector = useColor ? colorize(BRANCH, "gray") : BRANCH;
-    const connectorBottom = useColor ? colorize(BRANCH_END, "gray") : BRANCH_END;
-    const separator = useColor ? colorize(SEPARATOR, "gray") : SEPARATOR;
+    const tagOut = paint(tag, TAG_COLOR[channel]);
+    const timeStamp = paint(getTimeStamp(), "teal");
+    const locOut = paint(`(${location})`, "dimTeal");
+    const connector = paint(BRANCH, "gray");
+    const connectorBottom = paint(BRANCH_END, "gray");
+    const separator = paint(SEPARATOR, "gray");
     // Layout: the tag, the message hanging off a `├──` branch, then the timestamp
     // and location on a `└──` branch below. Leading `\n` spaces entries apart.
     const message = renderMessage(args, useColor);

package/dist/tap/tapAsync.js

@@ -102,23 +102,18 @@ async function readBody(res) {
  *   │  └── name:  Leanne Graham
  */
 function buildBlock(label, ms, res, body, useColor) {
-    const pipe = useColor ? colorize("│", "gray") : "│";
-    const branch = useColor ? colorize("├──", "gray") : "├──";
-    const last = useColor ? colorize("└──", "gray") : "└──";
+    const paint = (s, c) => useColor ? colorize(s, c) : s;
+    const pipe = paint("│", "gray");
+    const branch = paint("├──", "gray");
+    const last = paint("└──", "gray");
     const indent = `${pipe}  `;
-    const statusLine = `${indent}${branch} status: ${formatStatus(res, useColor)}`;
     const timeLine = `${indent}${branch} time:   ${formatDuration(ms, useColor)}`;
+    const statusLine = `${indent}${branch} status: ${formatStatus(res, useColor)}`;
     const sizeLine = `${indent}${last} size:   ${body.size}`;
-    const responseBlock = [
-        `${pipe}`,
-        `${indent}response:`,
-        timeLine,
-        statusLine,
-        sizeLine,
-    ].join("\n");
+    const responseLines = [`${pipe}`, `${indent}response:`, timeLine, statusLine, sizeLine];
+    const head = label === undefined ? "" : `${label}\n`;
     if (body.data === undefined) {
-        const head = label === undefined ? "" : `${label}\n`;
-        return [`${head}${responseBlock}`];
+        return [`${head}${responseLines.join("\n")}`];
     }
     // Render the body using util.formatWithOptions so objects/arrays look like
     // console.log output — colors, proper nesting, no JSON.stringify quirkiness.
@@ -128,17 +123,7 @@ function buildBlock(label, ms, res, body, useColor) {
     const bodyBlock = bodyLines
         .map((line, i) => `${indent}${i === lastIdx ? last : branch} ${line}`)
         .join("\n");
-    const full = [
-        `${pipe}`,
-        `${indent}response:`,
-        timeLine,
-        statusLine,
-        sizeLine,
-        `${pipe}`,
-        `${indent}body:`,
-        bodyBlock,
-    ].join("\n");
-    const head = label === undefined ? "" : `${label}\n`;
+    const full = [...responseLines, `${pipe}`, `${indent}body:`, bodyBlock].join("\n");
     return [`${head}${full}`];
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meadown/logger",
-  "version": "1.8.6",
+  "version": "1.8.8",
   "description": "A development-focused logger for Node.js and TypeScript — zero dependencies, clickable source links, and API response logging built in.",
   "keywords": [
     "logger",