@holz/json-backend 0.5.0 → 0.7.0-rc.1

package/README.md

@@ -0,0 +1,21 @@
+# `@holz/json-backend`
+
+Prints structured logs to a writable stream in NDJSON form.
+
+## Usage
+
+```typescript
+import { createJsonBackend } from '@holz/json-backend';
+import { createLogger } from '@holz/core';
+import * as fs from 'node:fs';
+
+const logger = createLogger(
+  createJsonBackend({
+    stream: fs.createWriteStream('my-app.log', { flags: 'a' }),
+  })
+);
+```
+
+Logs are output in [NDJSON](http://ndjson.org/) format. The output is optimized for log files, following the order of typical log statements. The output includes the log level, timestamp, message, and context, if provided.
+
+The `stream` option specifies where the logs will be written to. You can use any writable stream, such as a file or `process.stdout`.

package/dist/holz-json-backend.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const c=require("node:os");function o({stream:t}){return e=>{const n=JSON.stringify({level:e.level,time:new Date().toISOString(),msg:e.message,ctx:Object.keys(e.context).length>0?e.context:void 0});t.write(`${n}${c.EOL}`)}}exports.createJsonBackend=o;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const c=require("node:os");function r({stream:t}){return e=>{const n=JSON.stringify({level:e.level,time:new Date().toISOString(),msg:e.message,ctx:Object.keys(e.context).length>0?e.context:void 0});t.write(`${n}${c.EOL}`)}}exports.createJsonBackend=r;

package/dist/holz-json-backend.d.ts

@@ -0,0 +1,22 @@
+import { LogProcessor } from '@holz/core';
+import { Writable } from 'node:stream';
+
+declare interface Config {
+    /** Where to print logs. */
+    stream: Writable;
+}
+
+/**
+ * Prints structured logs to a writable stream in NDJSON form. Optimized for
+ * log files.
+ *
+ * @example
+ * createJsonBackend({
+ *   stream: fs.createWriteStream('my-app.log', { flags: 'a' }),
+ * })
+ *
+ * @see http://ndjson.org
+ */
+export declare function createJsonBackend({ stream }: Config): LogProcessor;
+
+export { }

package/dist/holz-json-backend.js

@@ -1,13 +1,13 @@
 import { EOL as r } from "node:os";
-function i({ stream: e }) {
-  return (t) => {
+function i({ stream: t }) {
+  return (e) => {
     const n = JSON.stringify({
-      level: t.level,
-      time: new Date().toISOString(),
-      msg: t.message,
-      ctx: Object.keys(t.context).length > 0 ? t.context : void 0
+      level: e.level,
+      time: (/* @__PURE__ */ new Date()).toISOString(),
+      msg: e.message,
+      ctx: Object.keys(e.context).length > 0 ? e.context : void 0
     });
-    e.write(`${n}${r}`);
+    t.write(`${n}${r}`);
   };
 }
 export {

package/package.json

@@ -1,11 +1,8 @@
 {
   "name": "@holz/json-backend",
-  "version": "0.5.0",
+  "version": "0.7.0-rc.1",
   "description": "Print logs as newline-delimited JSON.",
   "type": "module",
-  "main": "./dist/holz-json-backend.cjs",
-  "module": "./dist/holz-json-backend.js",
-  "types": "./src/index.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/PsychoLlama/holz",
@@ -13,6 +10,7 @@
   },
   "exports": {
     ".": {
+      "types": "./dist/holz-json-backend.d.ts",
       "require": "./dist/holz-json-backend.cjs",
       "import": "./dist/holz-json-backend.js"
     }
@@ -39,11 +37,14 @@
     "test:types": "tsc"
   },
   "devDependencies": {
-    "@holz/core": "^0.5.0",
-    "@types/node": "^18.14.0",
-    "@vitest/coverage-c8": "^0.28.5",
-    "typescript": "^4.9.5",
-    "vite": "^4.0.0",
-    "vitest": "^0.28.5"
-  }
+    "@holz/core": "^0.7.0-rc.1",
+    "@types/node": "^22.0.0",
+    "@vitest/coverage-v8": "^3.0.8",
+    "typescript": "^5.0.0",
+    "vite": "^6.0.0",
+    "vite-plugin-dts": "^4.5.3",
+    "vite-tsconfig-paths": "^5.1.4",
+    "vitest": "^3.0.8"
+  },
+  "stableVersion": "0.6.0"
 }

package/src/__tests__/__snapshots__/json-backend.test.ts.snap

@@ -1,9 +1,9 @@
-// Vitest Snapshot v1
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
 exports[`JSON backend > prints the logs to the writable stream 1`] = `
-"{\\"level\\":\\"debug\\",\\"time\\":\\"2020-06-15T12:00:00.000Z\\",\\"msg\\":\\"shout\\"}
-{\\"level\\":\\"info\\",\\"time\\":\\"2020-06-15T12:00:00.000Z\\",\\"msg\\":\\"normal\\"}
-{\\"level\\":\\"warn\\",\\"time\\":\\"2020-06-15T12:00:00.000Z\\",\\"msg\\":\\"hmmmm\\"}
-{\\"level\\":\\"error\\",\\"time\\":\\"2020-06-15T12:00:00.000Z\\",\\"msg\\":\\"oh no\\"}
+"{"level":"debug","time":"2020-06-15T12:00:00.000Z","msg":"shout"}
+{"level":"info","time":"2020-06-15T12:00:00.000Z","msg":"normal"}
+{"level":"warn","time":"2020-06-15T12:00:00.000Z","msg":"hmmmm"}
+{"level":"error","time":"2020-06-15T12:00:00.000Z","msg":"oh no"}
 "
 `;

package/src/__tests__/json-backend.test.ts

@@ -51,7 +51,7 @@ describe('JSON backend', () => {
     logger.debug('sneaky log\nwith newlines\rand carriage returns\r\n');
 
     expect(getOutput()).toContain(
-      'sneaky log\\nwith newlines\\rand carriage returns\\r\\n'
+      'sneaky log\\nwith newlines\\rand carriage returns\\r\\n',
     );
   });