@holz/logger 0.5.0 → 0.6.1

package/README.md

@@ -0,0 +1,51 @@
+# `@holz/logger`
+
+A lightweight and customizable logger for Node.js and browser environments.
+
+## Installation
+
+Install with [npm](https://www.npmjs.com/):
+
+```bash
+npm install @holz/logger
+```
+
+## Usage
+
+To use the logger, import it into your project:
+
+```typescript
+import logger from '@holz/logger';
+```
+
+After that, you can start logging messages with different log levels:
+
+```typescript
+logger.debug('This is a debug message');
+logger.info('This is an info message');
+logger.warn('This is a warning message');
+logger.error('This is an error message');
+```
+
+By default, logs are formatted with a timestamp, log level, namespace (if provided), and message. You can also add a namespace to your logs to help organize them:
+
+```typescript
+const dbLogger = logger.namespace('db');
+dbLogger.info('Connected to database');
+```
+
+If you don't see logs, you may need to enable them. You can do this by setting the `DEBUG` environment variable to `your-app*` or setting `localStorage.debug` to `your-app*`. For example, to enable logs in a Node.js script:
+
+```bash
+DEBUG='your-app*' node script.js
+```
+
+Holz is suitable for use in other libraries as you can enable logs when needed, without cluttering downstream application logs.
+
+## Customizing the Logger
+
+`@holz/logger` is a bundle of plugins that can be used separately to build a custom logger. The library uses several plugins, such as [`@holz/ansi-terminal-backend`](https://github.com/PsychoLlama/holz/tree/main/packages/holz-ansi-terminal-backend) for colorizing logs, [`@holz/stream-backend`](https://github.com/PsychoLlama/holz/tree/main/packages/holz-stream-backend) for writing logs to files in plain text format, and [`@holz/console-backend`](https://github.com/PsychoLlama/holz/tree/main/packages/holz-console-backend) for logging to the browser console.
+
+Although the bundled logger is opinionated and not configurable, you can easily use the individual plugins to create a logger tailored to your needs. The logger's foundation is the `createLogger(backend)` function from [`@holz/core`](https://github.com/PsychoLlama/holz/tree/main/packages/holz-core), and you can select the plugins to include based on your requirements.
+
+For more details check out [the documentation](https://github.com/PsychoLlama/holz/blob/main/README.md) or look at [an example](https://github.com/PsychoLlama/holz/blob/main/packages/holz-logger/src/index.browser.ts).

package/dist/browser-logger.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const e=require("@holz/console-backend"),r=require("@holz/core"),o=require("@holz/env-filter"),t=r.createLogger(o.createEnvironmentFilter({processor:e.createConsoleBackend()}));exports.default=t;
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const e=require("@holz/console-backend"),r=require("@holz/core"),t=require("@holz/env-filter"),o=r.createLogger(t.createEnvironmentFilter({processor:e.createConsoleBackend(),defaultPattern:""}));exports.default=o;

package/dist/browser-logger.js

@@ -1,9 +1,12 @@
-import { createConsoleBackend as r } from "@holz/console-backend";
-import { createLogger as e } from "@holz/core";
+import { createConsoleBackend as e } from "@holz/console-backend";
+import { createLogger as r } from "@holz/core";
 import { createEnvironmentFilter as o } from "@holz/env-filter";
-const c = e(
-  o({ processor: r() })
+const n = r(
+  o({
+    processor: e(),
+    defaultPattern: ""
+  })
 );
 export {
-  c as default
+  n as default
 };

package/dist/server-logger.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const r=require("node:tty"),s=require("@holz/ansi-terminal-backend"),e=require("@holz/core"),t=require("@holz/env-filter"),o=require("@holz/stream-backend"),{NODE_ENV:n}=process.env,c=r.isatty(process.stderr.fd)&&process.stderr.hasColors(3),a=e.createLogger(e.filter(()=>n!=="test",t.createEnvironmentFilter({processor:c?s.createAnsiTerminalBackend():o.createStreamBackend({stream:process.stderr})})));exports.default=a;
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const r=require("node:tty"),t=require("@holz/ansi-terminal-backend"),e=require("@holz/core"),s=require("@holz/env-filter"),o=require("@holz/stream-backend"),{NODE_ENV:n}=process.env,c=r.isatty(process.stderr.fd)&&process.stderr.hasColors(3),a=e.createLogger(e.filter(()=>n!=="test",s.createEnvironmentFilter({defaultPattern:"",processor:c?t.createAnsiTerminalBackend():o.createStreamBackend({stream:process.stderr})})));exports.default=a;

package/dist/server-logger.js

@@ -1,13 +1,14 @@
 import { isatty as r } from "node:tty";
 import { createAnsiTerminalBackend as e } from "@holz/ansi-terminal-backend";
-import { createLogger as o, filter as s } from "@holz/core";
-import { createEnvironmentFilter as t } from "@holz/env-filter";
-import { createStreamBackend as c } from "@holz/stream-backend";
-const { NODE_ENV: m } = process.env, a = r(process.stderr.fd) && process.stderr.hasColors(3), l = o(
-  s(
-    () => m !== "test",
-    t({
-      processor: a ? e() : c({ stream: process.stderr })
+import { createLogger as t, filter as o } from "@holz/core";
+import { createEnvironmentFilter as s } from "@holz/env-filter";
+import { createStreamBackend as a } from "@holz/stream-backend";
+const { NODE_ENV: c } = process.env, m = r(process.stderr.fd) && process.stderr.hasColors(3), l = t(
+  o(
+    () => c !== "test",
+    s({
+      defaultPattern: "",
+      processor: m ? e() : a({ stream: process.stderr })
     })
   )
 );

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@holz/logger",
-  "version": "0.5.0",
+  "version": "0.6.1",
   "description": "A preconfigured, general-purpose logger",
   "type": "module",
   "main": "./dist/browser-logger.cjs",
@@ -49,17 +49,17 @@
     "test:types": "tsc"
   },
   "dependencies": {
-    "@holz/ansi-terminal-backend": "^0.5.0",
-    "@holz/console-backend": "^0.5.0",
-    "@holz/core": "^0.5.0",
-    "@holz/env-filter": "^0.5.0",
-    "@holz/stream-backend": "^0.5.0"
+    "@holz/ansi-terminal-backend": "^0.6.0",
+    "@holz/console-backend": "^0.6.1",
+    "@holz/core": "^0.6.0",
+    "@holz/env-filter": "^0.6.1",
+    "@holz/stream-backend": "^0.6.0"
   },
   "devDependencies": {
     "@types/node": "^18.14.0",
-    "@vitest/coverage-c8": "^0.28.5",
-    "typescript": "^4.9.5",
+    "@vitest/coverage-v8": "^0.33.0",
+    "typescript": "^5.0.0",
     "vite": "^4.0.0",
-    "vitest": "^0.28.5"
+    "vitest": "^0.33.0"
   }
 }

package/src/index.browser.ts

@@ -3,7 +3,10 @@ import { createLogger } from '@holz/core';
 import { createEnvironmentFilter } from '@holz/env-filter';
 
 const logger = createLogger(
-  createEnvironmentFilter({ processor: createConsoleBackend() })
+  createEnvironmentFilter({
+    processor: createConsoleBackend(),
+    defaultPattern: '',
+  }),
 );
 
 export default logger;

package/src/index.node.ts

@@ -13,11 +13,12 @@ const logger = createLogger(
   filter(
     () => NODE_ENV !== 'test',
     createEnvironmentFilter({
+      defaultPattern: '',
       processor: supportsAnsiColors
         ? createAnsiTerminalBackend()
         : createStreamBackend({ stream: process.stderr }),
-    })
-  )
+    }),
+  ),
 );
 
 export default logger;