@meadown/logger 1.5.1 → 1.6.0

package/README.md

@@ -24,13 +24,13 @@ yarn add @meadown/logger
 ## Using it
 
 ```ts
-import customLog from "@meadown/logger"
+import logger from "@meadown/logger"
 
-customLog("Hello world")
-customLog("Auth", "user logged in") // every argument is printed as-is, like console.log
+logger("Hello world")
+logger("Auth", "user logged in") // every argument is printed as-is, like console.log
 
-customLog.warn("This is deprecated")
-customLog.error("Something went wrong")
+logger.warn("This is deprecated")
+logger.error("Something went wrong")
 ```
 
 You'll see something like:
@@ -55,10 +55,10 @@ wrapper makes every log blame _that_ file instead of wherever you actually logge
 
 ```ts
 // GOOD: pass it through — the (file:line) stays honest
-export { default as customLog } from "@meadown/logger"
+export { default as logger } from "@meadown/logger"
 
 // BAD: now every log points at this file, not the real caller
-export const customLog = (...args) => log(...args)
+export const logger = (...args) => log(...args)
 ```
 
 ## Color-coded levels
@@ -91,14 +91,26 @@ chatty multi-line message is drowning out your terminal, you can cap how many
 lines each message shows:
 
 ```ts
-import customLog from "@meadown/logger"
+import logger from "@meadown/logger"
 
-customLog.maxLines = 5 // show the first 5 lines, then "... N more lines"
-customLog.maxLines = 0 // back to the default — show everything
+logger.maxLines = 5 // show the first 5 lines, then "... N more lines"
+logger.maxLines = 0 // back to the default — show everything
 ```
 
 It only trims the _message_, never the tag, timestamp, or location, and the setting
-applies to `customLog`, `.error`, and `.warn` alike.
+applies to `logger`, `.error`, and `.warn` alike.
+
+## Deprecated alias
+
+Older examples used `customLog`. That name still works as a named export for now,
+but it is deprecated and new code should use `logger`:
+
+```ts
+import logger, { customLog } from "@meadown/logger"
+
+logger("new code")
+customLog("old code still works") // deprecated
+```
 
 ## What about production?
 

package/dist/cjs/index.d.ts

@@ -9,6 +9,21 @@ export interface LogFN {
      */
     maxLines: number;
 }
+/**
+ * Logs to the console, but only outside production. Each line is prefixed with
+ * a level tag, a short local timestamp, and a clickable link to the file it was
+ * called from; all arguments are then printed as-is.
+ * @example
+ * logger("Auth", "user logged in")
+ * // [INFO] 05-30 04:00:00 PM (server.ts:42) Auth user logged in
+ * @example
+ * logger.maxLines = 5 // long messages collapse to 5 lines; 0 = show all
+ */
+declare const logger: LogFN;
+/**
+ * @deprecated Use {@link logger} instead. This alias remains for compatibility
+ * with older examples and will be removed in a future major version.
+ */
 declare const customLog: LogFN;
-export { customLog };
-export default customLog;
+export { customLog, logger };
+export default logger;

package/dist/cjs/index.js

@@ -6,22 +6,23 @@
  * All rights reserved
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.customLog = void 0;
+exports.logger = exports.customLog = void 0;
 const index_js_1 = require("./utils/index.js");
 /**
  * Logs to the console, but only outside production. Each line is prefixed with
  * a level tag, a short local timestamp, and a clickable link to the file it was
  * called from; all arguments are then printed as-is.
  * @example
- * customLog("Auth", "user logged in")
+ * logger("Auth", "user logged in")
  * // [INFO] 05-30 04:00:00 PM (server.ts:42) Auth user logged in
  * @example
- * customLog.maxLines = 5 // long messages collapse to 5 lines; 0 = show all
+ * logger.maxLines = 5 // long messages collapse to 5 lines; 0 = show all
  */
 const logger = Object.assign((0, index_js_1.createLog)("log", "[INFO]"), {
     error: (0, index_js_1.createLog)("error", "[ERROR]"),
     warn: (0, index_js_1.createLog)("warn", "[WARN]"),
 });
+exports.logger = logger;
 // `maxLines` is a live getter/setter backed by the shared collapse setting, so
 // setting it once affects info, error, and warn alike.
 Object.defineProperty(logger, "maxLines", {
@@ -30,6 +31,10 @@ Object.defineProperty(logger, "maxLines", {
     enumerable: true,
     configurable: true,
 });
+/**
+ * @deprecated Use {@link logger} instead. This alias remains for compatibility
+ * with older examples and will be removed in a future major version.
+ */
 const customLog = logger;
 exports.customLog = customLog;
-exports.default = customLog;
+exports.default = logger;

package/dist/index.d.ts

@@ -9,7 +9,22 @@ export interface LogFN {
      */
     maxLines: number;
 }
+/**
+ * Logs to the console, but only outside production. Each line is prefixed with
+ * a level tag, a short local timestamp, and a clickable link to the file it was
+ * called from; all arguments are then printed as-is.
+ * @example
+ * logger("Auth", "user logged in")
+ * // [INFO] 05-30 04:00:00 PM (server.ts:42) Auth user logged in
+ * @example
+ * logger.maxLines = 5 // long messages collapse to 5 lines; 0 = show all
+ */
+declare const logger: LogFN;
+/**
+ * @deprecated Use {@link logger} instead. This alias remains for compatibility
+ * with older examples and will be removed in a future major version.
+ */
 declare const customLog: LogFN;
-export { customLog };
-export default customLog;
+export { customLog, logger };
+export default logger;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AASA,gFAAgF;AAChF,MAAM,WAAW,KAAK;IACpB,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IAC1B,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IAC/B,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IAC9B;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAA;CACjB;AA0BD,QAAA,MAAM,SAAS,EAAa,KAAK,CAAA;AAEjC,OAAO,EAAE,SAAS,EAAE,CAAA;AACpB,eAAe,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AASA,gFAAgF;AAChF,MAAM,WAAW,KAAK;IACpB,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IAC1B,KAAK,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IAC/B,IAAI,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;IAC9B;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;;;;;;GASG;AACH,QAAA,MAAM,MAAM,EAGN,KAAK,CAAA;AAWX;;;GAGG;AACH,QAAA,MAAM,SAAS,OAAS,CAAA;AAExB,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,CAAA;AAC5B,eAAe,MAAM,CAAA"}

package/dist/index.js

@@ -10,10 +10,10 @@ import { createLog, getVisibleLines, setVisibleLines } from "./utils/index.js";
  * a level tag, a short local timestamp, and a clickable link to the file it was
  * called from; all arguments are then printed as-is.
  * @example
- * customLog("Auth", "user logged in")
+ * logger("Auth", "user logged in")
  * // [INFO] 05-30 04:00:00 PM (server.ts:42) Auth user logged in
  * @example
- * customLog.maxLines = 5 // long messages collapse to 5 lines; 0 = show all
+ * logger.maxLines = 5 // long messages collapse to 5 lines; 0 = show all
  */
 const logger = Object.assign(createLog("log", "[INFO]"), {
     error: createLog("error", "[ERROR]"),
@@ -27,7 +27,11 @@ Object.defineProperty(logger, "maxLines", {
     enumerable: true,
     configurable: true,
 });
+/**
+ * @deprecated Use {@link logger} instead. This alias remains for compatibility
+ * with older examples and will be removed in a future major version.
+ */
 const customLog = logger;
-export { customLog };
-export default customLog;
+export { customLog, logger };
+export default logger;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAc9E;;;;;;;;;GASG;AACH,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE;IACvD,KAAK,EAAE,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC;IACpC,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC;CAClC,CAAC,CAAA;AAEF,+EAA+E;AAC/E,uDAAuD;AACvD,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,UAAU,EAAE;IACxC,GAAG,EAAE,eAAe;IACpB,GAAG,EAAE,eAAe;IACpB,UAAU,EAAE,IAAI;IAChB,YAAY,EAAE,IAAI;CACnB,CAAC,CAAA;AAEF,MAAM,SAAS,GAAG,MAAe,CAAA;AAEjC,OAAO,EAAE,SAAS,EAAE,CAAA;AACpB,eAAe,SAAS,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AAc9E;;;;;;;;;GASG;AACH,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE;IACvD,KAAK,EAAE,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC;IACpC,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC;CAClC,CAAU,CAAA;AAEX,+EAA+E;AAC/E,uDAAuD;AACvD,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,UAAU,EAAE;IACxC,GAAG,EAAE,eAAe;IACpB,GAAG,EAAE,eAAe;IACpB,UAAU,EAAE,IAAI;IAChB,YAAY,EAAE,IAAI;CACnB,CAAC,CAAA;AAEF;;;GAGG;AACH,MAAM,SAAS,GAAG,MAAM,CAAA;AAExB,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,CAAA;AAC5B,eAAe,MAAM,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@meadown/logger",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "description": "A tiny, zero-dependency logger for Node.js and TypeScript that tags each line, timestamps it, shows the source file and line, and goes quiet in production.",
   "keywords": [
     "logger",