@holz/ansi-terminal-backend 0.5.0 → 0.7.0-rc.1

package/README.md

@@ -0,0 +1,28 @@
+# `@holz/ansi-terminal-backend`
+
+Pretty-print logs to the terminal.
+
+<img alt="Screenshot of logs printed to the terminal" src="https://user-images.githubusercontent.com/10053423/222926680-0a12da0c-5ff2-40a1-8759-5dca72eb89c3.png" width="600" />
+
+## Usage
+
+```typescript
+import { createAnsiTerminalBackend } from '@holz/ansi-terminal-backend';
+
+const logger = createLogger(createAnsiTerminalBackend());
+```
+
+> **Note**  
+> There is no way to disable colors. The output relies on colors to convey structure. To disable colors, use a different backend such as [`@holz/stream-backend`](https://github.com/PsychoLlama/holz/tree/main/packages/holz-stream-backend).
+
+## Options
+
+```typescript
+createAnsiTerminalBackend({
+  /**
+   * By default it prints to the global console, but you can override it.
+   * See: https://nodejs.org/api/console.html#new-consoleoptions
+   */
+  console: new Console(custom.stdout, custom.stderr),
+});
+```

package/dist/holz-ansi-terminal-backend.d.ts

@@ -0,0 +1,24 @@
+import { LogProcessor } from '@holz/core';
+
+/**
+ * A backend that prints logs to a 3-bit ansi terminal. This should work on
+ * most Unix systems and Windows >= 10.
+ *
+ * NOTE: This is not smart enough to detect if the output is a TTY or if it
+ * supports colors, nor is this the appropriate place to check. Without color
+ * ques, the printed text is much less understandable. It is better to check
+ * when constructing the logger instead.
+ */
+export declare function createAnsiTerminalBackend(options?: Options): LogProcessor;
+
+declare interface Options {
+    /**
+     * Defaults the global `console`, but in NodeJS you can create a console
+     * over any writable stream. It could be a file or a network socket.
+     *
+     * @see https://nodejs.org/api/console.html#new-consoleoptions
+     */
+    console?: Console;
+}
+
+export { }

package/dist/holz-ansi-terminal-backend.js

@@ -6,7 +6,7 @@ const e = o("0m"), u = o("2m"), g = o("31m"), p = o("32m"), S = o("33m"), f = o(
 function v(t = {}) {
   const r = t.console ?? console, i = " ".repeat(s.Error.length);
   return (n) => {
-    const m = b(new Date()), a = `${e}${u}${m}${e}`, l = [
+    const m = b(/* @__PURE__ */ new Date()), a = `${e}${u}${m}${e}`, l = [
       {
         include: !0,
         command: "%s",

package/package.json

@@ -1,11 +1,8 @@
 {
   "name": "@holz/ansi-terminal-backend",
-  "version": "0.5.0",
+  "version": "0.7.0-rc.1",
   "description": "An ANSI terminal backend for Holz",
   "type": "module",
-  "main": "./dist/holz-ansi-terminal-backend.cjs",
-  "module": "./dist/holz-ansi-terminal-backend.js",
-  "types": "./src/index.ts",
   "repository": {
     "type": "git",
     "url": "https://github.com/PsychoLlama/holz",
@@ -13,6 +10,7 @@
   },
   "exports": {
     ".": {
+      "types": "./dist/holz-ansi-terminal-backend.d.ts",
       "require": "./dist/holz-ansi-terminal-backend.cjs",
       "import": "./dist/holz-ansi-terminal-backend.js"
     }
@@ -38,14 +36,17 @@
     "test:types": "tsc"
   },
   "peerDependencies": {
-    "@holz/core": "^0.5.0"
+    "@holz/core": "^0.7.0-rc.1"
   },
   "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/ansi-terminal-backend.ts

@@ -34,7 +34,7 @@ export function createAnsiTerminalBackend(options: Options = {}): LogProcessor {
         command: '%s',
         content: log.message.replace(
           /(\r?\n)/g,
-          `$1${timestampPrefix} ${labelSizeInWhitespace} `
+          `$1${timestampPrefix} ${labelSizeInWhitespace} `,
         ),
       },
       {