@logtape/logtape 0.2.0 → 0.2.2

package/README.md

@@ -12,9 +12,33 @@ LogTape
 > LogTape is still in the early stage of development.  The API is not stable
 > yet.  Please be careful when using it in production.
 
-LogTape is a simple logging library with zero dependencies for
-Deno/Node.js/Bun/browsers.  It is designed to be used for both applications
-and libraries.
+LogTape is a logging library for JavaScript and TypeScript.  It provides a
+simple and flexible logging system that is easy to use and easy to extend.
+The highlights of LogTape are:
+
+ -  *Zero dependencies*: LogTape has zero dependencies.  You can use LogTape
+    without worrying about the dependencies of LogTape.
+
+ -  *Library support*: LogTape is designed to be used in libraries as well
+    as applications.  You can use LogTape in libraries to provide logging
+    capabilities to users of the libraries.
+
+ -  *Runtime diversity*: LogTape supports Deno, Node.js, Bun, edge functions,
+    and browsers.  You can use LogTape in various environments without
+    changing the code.
+
+ -  *Structured logging*: You can log messages with structured data.
+
+ -  *Hierarchical categories*: LogTape uses a hierarchical category system
+    to manage loggers.  You can control the verbosity of log messages by
+    setting the log level of loggers at different levels of the category
+    hierarchy.
+
+ -  *Template literals*: LogTape supports template literals for log messages.
+    You can use template literals to log messages with placeholders and
+    values.
+
+ -  *Dead simple sinks*: You can easily add your own sinks to LogTape.
 
 Currently, LogTape provides only few sinks, but [you can easily add your own
 sinks.](#sinks)
@@ -23,7 +47,7 @@ sinks.](#sinks)
 ![](./screenshots/terminal-console.png)
 
 [JSR]: https://jsr.io/@logtape/logtape
-[JSR badge]: https://jsr.io/badges/@logtape/logtape?v=0.2.0
+[JSR badge]: https://jsr.io/badges/@logtape/logtape?v=0.2.1
 [npm]: https://www.npmjs.com/package/@logtape/logtape
 [npm badge]: https://img.shields.io/npm/v/@logtape/logtape?logo=npm
 [GitHub Actions]: https://github.com/dahlia/logtape/actions/workflows/main.yaml
@@ -100,7 +124,8 @@ logger.error `This is an error message with ${value}.`;
 logger.fatal `This is a fatal message with ${value}.`;
 ~~~~
 
-You can also log messages with a function call:
+You can also log messages with a function call.  In this case, log messages
+are structured data:
 
 ~~~~ typescript
 logger.debug("This is a debug message with {value}.", { value });

package/esm/config.js

@@ -6,6 +6,12 @@ import { getConsoleSink } from "./sink.js";
  * Whether the loggers are configured.
  */
 let configured = false;
+/**
+ * Strong references to the loggers.
+ * This is to prevent the loggers from being garbage collected so that their
+ * sinks and filters are not removed.
+ */
+const strongRefs = new Set();
 /**
  * Disposables to dispose when resetting the configuration.
  */
@@ -87,6 +93,7 @@ export async function configure(config) {
             }
             logger.filters.push(toFilter(filter));
         }
+        strongRefs.add(logger);
     }
     for (const sink of Object.values(config.sinks)) {
         if (Symbol.asyncDispose in sink) {
@@ -129,6 +136,7 @@ export async function configure(config) {
 export async function reset() {
     await dispose();
     LoggerImpl.getLogger([]).resetDescendants();
+    strongRefs.clear();
     configured = false;
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logtape/logtape",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Simple logging library with zero dependencies for Deno/Node.js/Bun/browsers",
   "keywords": [
     "logging",

package/script/config.js

@@ -32,6 +32,12 @@ const sink_js_1 = require("./sink.js");
  * Whether the loggers are configured.
  */
 let configured = false;
+/**
+ * Strong references to the loggers.
+ * This is to prevent the loggers from being garbage collected so that their
+ * sinks and filters are not removed.
+ */
+const strongRefs = new Set();
 /**
  * Disposables to dispose when resetting the configuration.
  */
@@ -113,6 +119,7 @@ async function configure(config) {
             }
             logger.filters.push((0, filter_js_1.toFilter)(filter));
         }
+        strongRefs.add(logger);
     }
     for (const sink of Object.values(config.sinks)) {
         if (Symbol.asyncDispose in sink) {
@@ -156,6 +163,7 @@ exports.configure = configure;
 async function reset() {
     await dispose();
     logger_js_1.LoggerImpl.getLogger([]).resetDescendants();
+    strongRefs.clear();
     configured = false;
 }
 exports.reset = reset;

package/types/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,UAAU,EAAY,MAAM,aAAa,CAAC;AAExD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAkB,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,MAAM,CAAC,OAAO,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM;IACtE;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC7B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;IAE5C;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY,CAC3B,OAAO,SAAS,MAAM,EACtB,SAAS,SAAS,MAAM;IAExB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;IAEtB;;;OAGG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;CACzB;AAiBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAsB,SAAS,CAC7B,OAAO,SAAS,MAAM,EACtB,SAAS,SAAS,MAAM,EACxB,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CA8EnD;AAED;;GAEG;AACH,wBAAsB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAI3C;AAED;;GAEG;AACH,wBAAsB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAS7C;AAED;;GAEG;AACH,qBAAa,WAAY,SAAQ,KAAK;IACpC;;;OAGG;gBACS,OAAO,EAAE,MAAM;CAI5B"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,UAAU,EAAY,MAAM,aAAa,CAAC;AAExD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAkB,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,MAAM,CAAC,OAAO,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM;IACtE;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC7B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;IAE5C;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY,CAC3B,OAAO,SAAS,MAAM,EACtB,SAAS,SAAS,MAAM;IAExB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;IAEtB;;;OAGG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;CACzB;AAwBD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAsB,SAAS,CAC7B,OAAO,SAAS,MAAM,EACtB,SAAS,SAAS,MAAM,EACxB,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CA+EnD;AAED;;GAEG;AACH,wBAAsB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAK3C;AAED;;GAEG;AACH,wBAAsB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAS7C;AAED;;GAEG;AACH,qBAAa,WAAY,SAAQ,KAAK;IACpC;;;OAGG;gBACS,OAAO,EAAE,MAAM;CAI5B"}

package/types/mod.d.ts

@@ -4,5 +4,5 @@ export { type Filter, type FilterLike, getLevelFilter, toFilter, } from "./filte
 export { type ConsoleFormatter, defaultConsoleFormatter, defaultTextFormatter, type TextFormatter, } from "./formatter.js";
 export { getLogger, type Logger } from "./logger.js";
 export type { LogLevel, LogRecord } from "./record.js";
-export { type ConsoleSinkOptions, type FileSinkDriver, type FileSinkOptions, getConsoleSink, getStreamSink, type Sink, type StreamSinkOptions, } from "./sink.js";
+export { type ConsoleSinkOptions, type FileSinkOptions, getConsoleSink, getStreamSink, type RotatingFileSinkOptions, type Sink, type StreamSinkOptions, } from "./sink.js";
 //# sourceMappingURL=mod.d.ts.map

package/types/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,WAAW,EACX,SAAS,EACT,OAAO,EACP,KAAK,YAAY,EACjB,KAAK,GACN,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EACL,KAAK,MAAM,EACX,KAAK,UAAU,EACf,cAAc,EACd,QAAQ,GACT,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,KAAK,gBAAgB,EACrB,uBAAuB,EACvB,oBAAoB,EACpB,KAAK,aAAa,GACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AACrD,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,cAAc,EACd,aAAa,EACb,KAAK,IAAI,EACT,KAAK,iBAAiB,GACvB,MAAM,WAAW,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,WAAW,EACX,SAAS,EACT,OAAO,EACP,KAAK,YAAY,EACjB,KAAK,GACN,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EACL,KAAK,MAAM,EACX,KAAK,UAAU,EACf,cAAc,EACd,QAAQ,GACT,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,KAAK,gBAAgB,EACrB,uBAAuB,EACvB,oBAAoB,EACpB,KAAK,aAAa,GACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AACrD,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,eAAe,EACpB,cAAc,EACd,aAAa,EACb,KAAK,uBAAuB,EAC5B,KAAK,IAAI,EACT,KAAK,iBAAiB,GACvB,MAAM,WAAW,CAAC"}