@witchcraft/nuxt-logger 0.0.11 → 0.1.0

package/README.md

@@ -1,7 +1,8 @@
 # @witchcraft/nuxt-logger
 
+[![Docs][docs-src]][docs-href]
+[![Release][release-src]][release-href]
 [![npm version][npm-version-src]][npm-version-href]
-[![npm downloads][npm-downloads-src]][npm-downloads-href]
 [![License][license-src]][license-href]
 [![Nuxt][nuxt-src]][nuxt-href]
 
@@ -41,6 +42,14 @@ By default redacts some known sensitive keys for the middleware logging requests
 
 Also redacts the `redact` key, but only in production, so you can put anything semi-sensitive in there that you need to inspect in development.
 
+### Server transports
+
+On the server the module adds two transports by default, file logging to `logPath` and pretty console logs through `pino-pretty`.
+
+Pino resolves the pretty transport at runtime from your app, not from this package. With strict dependency isolation (pnpm) or a bundled server (Nitro), that lookup fails and the server crashes with `unable to determine transport target for "pino-pretty"`. Give the app a copy it can find by adding `pino-pretty` to your app dependencies, or turn the pretty transport off with `disabledServerTransportTargets: ["pino-pretty"]`.
+
+In dev the module warns and keeps running without pretty console logs when `pino-pretty` cannot be resolved.
+
 ### Electron
 
 The electron logger requires a bit of setup since electron's main cannot be passed the runtime config normally.
@@ -51,7 +60,8 @@ This assumes the usage of
 There is a full example in the [@witchcraft/nuxt-electron playground](TODO).
 
 ```ts [main.ts]
-import { STATIC, useDevDataDir } from "@witchcraft/nuxt-electron/electron"
+import { useDevDataDir } from "@witchcraft/nuxt-electron/electron/main"
+import { STATIC } from "@witchcraft/nuxt-electron/electron"
 import { ELECTRON } from "@witchcraft/nuxt-logger/electron"
 
 // assuming you stick your active window instances here
@@ -83,7 +93,7 @@ We can setup the apis for two way communication in the preload script.
 ```ts
 // preload.ts
 import { contextBridge, ipcRenderer } from "electron"
-import { createElectronLoggerApi, type ElectronLoggerApi } from "@witchcraft/nuxt-logger/electron"
+import { createElectronLoggerApi, type ElectronLoggerApi } from "@witchcraft/nuxt-logger/electron/preload"
 
 declare global {
 	interface Window {
@@ -132,12 +142,13 @@ useLogger().debug({ns: "hello"}) // will also get forwarded if redirectAll is tr
 
 
 <!-- Badges -->
+[docs-src]: https://github.com/witchcraftjs/nuxt-logger/actions/workflows/docs.yml/badge.svg
+[docs-href]: https://github.com/witchcraftjs/nuxt-logger/actions/workflows/docs.yml
+[release-src]: https://github.com/witchcraftjs/nuxt-logger/actions/workflows/release.yml/badge.svg
+[release-href]: https://github.com/witchcraftjs/nuxt-logger/actions/workflows/release.yml
 [npm-version-src]: https://img.shields.io/npm/v/@witchcraft/nuxt-logger/latest.svg?style=flat&colorA=020420&colorB=00DC82
 [npm-version-href]: https://npmjs.com/package/@witchcraft/nuxt-logger
 
-[npm-downloads-src]: https://img.shields.io/npm/dm/@witchcraft/nuxt-logger.svg?style=flat&colorA=020420&colorB=00DC82
-[npm-downloads-href]: https://npmjs.com/package/@witchcraft/nuxt-logger
-
 [license-src]: https://img.shields.io/npm/l/@witchcraft/nuxt-logger.svg?style=flat&colorA=020420&colorB=00DC82
 [license-href]: https://npmjs.com/package/@witchcraft/nuxt-logger
 

package/dist/module.json

@@ -1,9 +1,9 @@
 {
   "name": "logger",
   "configKey": "logger",
-  "version": "0.0.11",
+  "version": "0.1.0",
   "builder": {
-    "@nuxt/module-builder": "1.0.2",
-    "unbuild": "3.6.1"
+    "@nuxt/module-builder": "1.0.3",
+    "unbuild": "unknown"
   }
 }

package/dist/module.mjs

@@ -81,9 +81,10 @@ const module$1 = defineNuxtModule({
     addPlugin(resolve("./runtime/plugins/init"));
     nuxt.options.alias["#logger"] = resolve("./runtime");
     nuxt.hook("vite:extendConfig", (config) => {
-      config.optimizeDeps ??= {};
-      config.optimizeDeps.include ??= [];
-      config.optimizeDeps.include.push("pino");
+      const optimizeDeps = config.optimizeDeps ?? {};
+      optimizeDeps.include ??= [];
+      optimizeDeps.include.push("pino");
+      Object.assign(config, { optimizeDeps });
     });
   }
 });

package/dist/runtime/electron/index.d.ts

@@ -1,4 +1 @@
-export { createElectronLoggerApi, type ElectronLoggerApi } from "./createElectronLoggerApi";
-export { useElectronLogger } from "./useElectronLogger";
-export { wrapLoggerForElectron } from "./wrapLoggerForElectron";
-export * from "./types";
+export * from "./types.js";

package/dist/runtime/electron/index.js

@@ -1,4 +1 @@
-export { createElectronLoggerApi } from "./createElectronLoggerApi.js";
-export { useElectronLogger } from "./useElectronLogger.js";
-export { wrapLoggerForElectron } from "./wrapLoggerForElectron.js";
 export * from "./types.js";

package/dist/runtime/electron/main/index.d.ts

@@ -0,0 +1,3 @@
+export { receiveFromRendererOnMain } from "./receiveFromRendererOnMain.js";
+export { useElectronLogger } from "./useElectronLogger.js";
+export { wrapLoggerForElectron } from "./wrapLoggerForElectron.js";

package/dist/runtime/electron/main/index.js

@@ -0,0 +1,3 @@
+export { receiveFromRendererOnMain } from "./receiveFromRendererOnMain.js";
+export { useElectronLogger } from "./useElectronLogger.js";
+export { wrapLoggerForElectron } from "./wrapLoggerForElectron.js";

package/dist/runtime/electron/{receiveFromRendererOnMain.js → main/receiveFromRendererOnMain.js}

@@ -1,5 +1,5 @@
 import { ipcMain } from "electron";
-import { ELECTRON_LOG_TYPE } from "./types.js";
+import { ELECTRON_LOG_TYPE } from "../types.js";
 export function receiveFromRendererOnMain(logger) {
   ipcMain.on(ELECTRON_LOG_TYPE.TO_MAIN, (_event, message) => {
     if (typeof message.data === "object" && typeof message.level === "string") {

package/dist/runtime/electron/{useElectronLogger.d.ts → main/useElectronLogger.d.ts}

@@ -1,5 +1,6 @@
 import type { PublicRuntimeConfig } from "@nuxt/schema";
 import { type BrowserWindow } from "electron";
+import pino from "pino";
 /**
  * A simplified wrapper around pino for use in electron main. Note that it does not support child logger and is actually a simple wrapper around just the basic levels.
  *
@@ -15,4 +16,4 @@ import { type BrowserWindow } from "electron";
  */
 export declare function useElectronLogger(pinoConfig?: PublicRuntimeConfig["logger"], windows?: () => BrowserWindow[], { receiveFromRenderer }?: {
     receiveFromRenderer?: boolean;
-}): Record<keyof import("pino").BaseLogger | keyof import("pino").LoggerExtras<never, boolean> | "customLevels" | "useOnlyCustomLevels", (data: any) => void>;
+}): Record<keyof pino.BaseLogger | keyof pino.LoggerExtras<never, boolean> | "customLevels" | "useOnlyCustomLevels", (data: any) => void>;

package/dist/runtime/electron/{useElectronLogger.js → main/useElectronLogger.js}

@@ -1,10 +1,10 @@
 import { keys } from "@alanscodelog/utils/keys";
 import { app } from "electron";
 import path from "node:path";
-import { pino } from "pino";
+import pino from "pino";
 import { receiveFromRendererOnMain } from "./receiveFromRendererOnMain.js";
-import { ELECTRON_LOG_TYPE } from "./types.js";
-import { getBaseOptions } from "../helpers/getBaseOptions.js";
+import { getBaseOptions } from "../../helpers/getBaseOptions.js";
+import { ELECTRON_LOG_TYPE } from "../types.js";
 globalThis.__bundlerPathsOverrides = {
   "pino-worker": `./node_modules/pino/lib/worker.js`,
   "pino-worker-pipeline": `./node_modules/pino/lib/worker-pipeline.js`,

package/dist/runtime/electron/{createElectronLoggerApi.d.ts → preload/createElectronLoggerApi.d.ts}

@@ -1,5 +1,5 @@
 import type { ipcRenderer as IpcRenderer } from "electron";
-import type { Levels } from "../types.js";
+import type { Levels } from "../../types.js";
 export type ElectronLoggerApi = {
     log: (level: Levels, data: any) => void;
     _logs: {

package/dist/runtime/electron/{createElectronLoggerApi.js → preload/createElectronLoggerApi.js}

@@ -1,4 +1,4 @@
-import { ELECTRON_LOG_TYPE } from "./types.js";
+import { ELECTRON_LOG_TYPE } from "../types.js";
 export function createElectronLoggerApi(ipcRenderer) {
   return {
     log: (level, data) => ipcRenderer.send(ELECTRON_LOG_TYPE.TO_MAIN, { level, data }),

package/dist/runtime/electron/preload/index.d.ts

@@ -0,0 +1 @@
+export { createElectronLoggerApi, type ElectronLoggerApi } from "./createElectronLoggerApi.js";

package/dist/runtime/electron/preload/index.js

@@ -0,0 +1 @@
+export { createElectronLoggerApi } from "./createElectronLoggerApi.js";

package/dist/runtime/shared/createUseLogger.js

@@ -1,4 +1,4 @@
-import { pino } from "pino";
+import pino from "pino";
 import { getBaseOptions } from "../helpers/getBaseOptions.js";
 const logger = {};
 export function createUseLogger(rc, serverPathResolver) {
@@ -14,7 +14,17 @@ export function createUseLogger(rc, serverPathResolver) {
       const { opts, transports, browserOpts, debug } = getBaseOptions(config.logger, serverPathResolver);
       let transport;
       if (import.meta.server) {
-        transport = pino.transport(transports);
+        try {
+          transport = pino.transport(transports);
+        } catch (e) {
+          const missingTarget = /unable to determine transport target for "([^"]+)"/.exec(e?.message ?? "")?.[1];
+          if (import.meta.dev && missingTarget === "pino-pretty") {
+            console.warn(`[nuxt-logger] "pino-pretty" could not be resolved, pretty console logs are disabled. Add "pino-pretty" to your app dependencies or set disabledServerTransportTargets: ["pino-pretty"].`);
+            transport = pino.transport({ targets: transports.targets.filter((t) => t.target !== "pino-pretty") });
+          } else {
+            throw e;
+          }
+        }
       }
       const pinoLogger = pino(
         {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@witchcraft/nuxt-logger",
-  "version": "0.0.11",
+  "version": "0.1.0",
   "description": "Nuxt module for logging.",
   "repository": "witchcraftjs/nuxt-logger",
   "license": "MIT",
@@ -11,13 +11,21 @@
       "types": "./dist/types.d.mts",
       "import": "./dist/module.mjs"
     },
-    "./*": {
-      "types": "./dist/runtime/*.d.ts",
-      "import": "./dist/runtime/*.js"
-    },
     "./electron": {
       "types": "./dist/runtime/electron/index.d.ts",
       "import": "./dist/runtime/electron/index.js"
+    },
+    "./electron/main": {
+      "types": "./dist/runtime/electron/main/index.d.ts",
+      "import": "./dist/runtime/electron/main/index.js"
+    },
+    "./electron/preload": {
+      "types": "./dist/runtime/electron/preload/index.d.ts",
+      "import": "./dist/runtime/electron/preload/index.js"
+    },
+    "./*": {
+      "types": "./dist/runtime/*.d.ts",
+      "import": "./dist/runtime/*.js"
     }
   },
   "files": [
@@ -30,18 +38,18 @@
     "pino-pretty": "^11.2.2"
   },
   "dependencies": {
-    "@alanscodelog/tsconfigs": "^6.2.0",
-    "@alanscodelog/utils": "^6.0.1",
+    "@alanscodelog/tsconfigs": "^6.3.1",
+    "@alanscodelog/utils": "^6.3.0",
     "@nuxt/kit": "^4.3.1",
     "defu": "latest",
     "pino": "^9.9.0",
     "pino-pretty": "^11.3.0"
   },
   "devDependencies": {
-    "@alanscodelog/eslint-config": "^6.3.1",
-    "@alanscodelog/semantic-release-config": "^6.0.2",
+    "@alanscodelog/eslint-config": "^6.3.2",
+    "@alanscodelog/semantic-release-config": "^6.0.3",
     "@nuxt/eslint-config": "^1.15.2",
-    "@nuxt/module-builder": "^1.0.2",
+    "@nuxt/module-builder": "^1.0.3",
     "@nuxt/schema": "^4.3.1",
     "@nuxt/test-utils": "^3.19.2",
     "@types/node": "latest",

package/src/module.ts

@@ -171,9 +171,10 @@ export default defineNuxtModule<ModuleOptions>({
 		nuxt.options.alias["#logger"] = resolve("./runtime")
 		nuxt.hook("vite:extendConfig", config => {
 		// fixes https://github.com/nuxt/nuxt/issues/13247 partially (also transpiling it breaks it)
-			config.optimizeDeps ??= {}
-			config.optimizeDeps.include ??= []
-			config.optimizeDeps.include.push("pino")
+			const optimizeDeps = config.optimizeDeps ?? {}
+			optimizeDeps.include ??= []
+			optimizeDeps.include.push("pino")
+			Object.assign(config, { optimizeDeps })
 		})
 	}
 })

package/src/runtime/electron/index.ts

@@ -1,6 +1 @@
-// note adding file endings breaks build types
-export { createElectronLoggerApi, type ElectronLoggerApi } from "./createElectronLoggerApi"
-
-export { useElectronLogger } from "./useElectronLogger"
-export { wrapLoggerForElectron } from "./wrapLoggerForElectron"
-export * from "./types"
+export * from "./types.js"

package/src/runtime/electron/main/index.ts

@@ -0,0 +1,3 @@
+export { receiveFromRendererOnMain } from "./receiveFromRendererOnMain.js"
+export { useElectronLogger } from "./useElectronLogger.js"
+export { wrapLoggerForElectron } from "./wrapLoggerForElectron.js"

package/src/runtime/electron/{receiveFromRendererOnMain.ts → main/receiveFromRendererOnMain.ts}

@@ -1,8 +1,9 @@
 import { ipcMain } from "electron"
 
-import { ELECTRON_LOG_TYPE } from "./types.js"
 import type { useElectronLogger } from "./useElectronLogger.js"
 
+import { ELECTRON_LOG_TYPE } from "../types.js"
+
 export function receiveFromRendererOnMain(logger: ReturnType<typeof useElectronLogger>): void {
 	ipcMain.on(ELECTRON_LOG_TYPE.TO_MAIN, (_event, message) => {
 		if (typeof message.data === "object" && typeof message.level === "string") {

package/src/runtime/electron/{useElectronLogger.ts → main/useElectronLogger.ts}

@@ -2,12 +2,12 @@ import { keys } from "@alanscodelog/utils/keys"
 import type { PublicRuntimeConfig } from "@nuxt/schema"
 import { app, type BrowserWindow } from "electron"
 import path from "node:path"
-import { type Logger, pino } from "pino"
+import pino, { type Logger } from "pino"
 
 import { receiveFromRendererOnMain } from "./receiveFromRendererOnMain.js"
-import { ELECTRON_LOG_TYPE } from "./types.js"
 
-import { getBaseOptions } from "../helpers/getBaseOptions.js"
+import { getBaseOptions } from "../../helpers/getBaseOptions.js"
+import { ELECTRON_LOG_TYPE } from "../types.js"
 
 declare const globalThis: any
 globalThis.__bundlerPathsOverrides = {

package/src/runtime/electron/{wrapLoggerForElectron.ts → main/wrapLoggerForElectron.ts}

@@ -6,11 +6,11 @@ export function wrapLoggerForElectron<T extends ReturnType<typeof useElectronLog
 	logger: T,
 	prefix: string = "main:"
 ): T {
-	const res = {}
-	for (const key of Object.keys(logger)) {
+	const res = {} as Record<keyof T, unknown>
+	for (const key of Object.keys(logger) as (keyof T)[]) {
 		res[key] = (...args: any[]) => {
-			logger[key]({ ...args[0], ns: prefix + args[0].ns }, ...args.slice(1))
+			(logger[key] as (...args: any[]) => void)({ ...args[0], ns: prefix + args[0].ns }, ...args.slice(1))
 		}
 	}
-	return res
+	return res as T
 }

package/src/runtime/electron/{createElectronLoggerApi.ts → preload/createElectronLoggerApi.ts}

@@ -1,8 +1,7 @@
 import type {	ipcRenderer as IpcRenderer } from "electron"
 
-import { ELECTRON_LOG_TYPE } from "./types.js"
-
-import type { Levels } from "../types.js"
+import type { Levels } from "../../types.js"
+import { ELECTRON_LOG_TYPE } from "../types.js"
 
 export type ElectronLoggerApi = {
 	log: (level: Levels, data: any) => void

package/src/runtime/electron/preload/index.ts

@@ -0,0 +1 @@
+export { createElectronLoggerApi, type ElectronLoggerApi } from "./createElectronLoggerApi.js"

package/src/runtime/shared/createUseLogger.ts

@@ -1,5 +1,5 @@
 import type { RuntimeConfig } from "nuxt/schema"
-import { type Logger, pino } from "pino"
+import pino, { type Logger } from "pino"
 
 import { getBaseOptions } from "../helpers/getBaseOptions.js"
 import type { BaseLogger, Levels } from "../types.js"
@@ -38,7 +38,17 @@ export function createUseLogger(
 			const { opts, transports, browserOpts, debug } = getBaseOptions(config.logger, serverPathResolver)
 			let transport: any
 			if (import.meta.server) {
-				transport = pino.transport(transports)
+				try {
+					transport = pino.transport(transports)
+				} catch (e) {
+					const missingTarget = /unable to determine transport target for "([^"]+)"/.exec((e as Error)?.message ?? "")?.[1]
+					if (import.meta.dev && missingTarget === "pino-pretty") {
+						console.warn(`[nuxt-logger] "pino-pretty" could not be resolved, pretty console logs are disabled. Add "pino-pretty" to your app dependencies or set disabledServerTransportTargets: ["pino-pretty"].`)
+						transport = pino.transport({ targets: transports.targets.filter(t => (t as any).target !== "pino-pretty") })
+					} else {
+						throw e
+					}
+				}
 			}
 			const pinoLogger = pino(
 				{