@witchcraft/nuxt-logger 0.0.2 → 0.0.4

package/README.md

@@ -46,7 +46,7 @@ Also redacts the `redact` key, but only in production, so you can put anything s
 The electron logger requires a bit of setup since electron's main cannot be passed the runtime config normally.
 
 This assumes the usage of
-[@witchcraft/nuxt-electron](todo) since it can handle this among other issues. Note this plugin needs to be before it in the plugins list.
+[@witchcraft/nuxt-electron](https://github.com/witchcraftjs/nuxt-electron) since it can handle this among other issues.
 
 There is a full example in the [@witchcraft/nuxt-electron playground](TODO).
 

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "logger",
   "configKey": "logger",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/dist/module.mjs

@@ -1,4 +1,4 @@
-import { defineNuxtModule, createResolver, resolvePath, addImportsDir, addServerImportsDir, addServerHandler, addPlugin } from '@nuxt/kit';
+import { defineNuxtModule, createResolver, resolveAlias, resolvePath, addImportsDir, addServerImportsDir, addServerHandler, addPlugin } from '@nuxt/kit';
 import { defu } from 'defu';
 import fs from 'node:fs/promises';
 import path from 'node:path';
@@ -27,10 +27,10 @@ const module = defineNuxtModule({
   },
   async setup(options, nuxt) {
     const { resolve } = createResolver(import.meta.url);
-    options.devServerLogPath ??= await resolvePath("~~/logs/server.log", { alias: nuxt.options.alias });
+    options.devServerLogPath ??= path.relative(nuxt.options.rootDir, resolveAlias("~~/logs/server.log", nuxt.options.alias));
     const maybeAppName = nuxt.options.runtimeConfig.public?.appInfo?.name;
     const appName = options.appName ?? maybeAppName ?? path.basename(await resolvePath("~~", { alias: nuxt.options.alias }));
-    options.serverLogPath ??= await resolvePath(`~~/logs/${appName}.log`, { alias: nuxt.options.alias });
+    options.serverLogPath ??= path.relative(nuxt.options.rootDir, resolveAlias(`~~/logs/${appName}.log`, nuxt.options.alias));
     if (process.env.NODE_ENV === "development") {
       if (!await fs.stat(options.devServerLogPath).then(() => true).catch(() => false)) {
         await fs.mkdir(path.dirname(options.devServerLogPath), {

package/dist/runtime/helpers/getBaseOptions.d.ts

@@ -1,11 +1,12 @@
 import type { PublicRuntimeConfig } from "@nuxt/schema";
 import type { LoggerOptions, TransportMultiOptions } from "pino";
-export declare function getBaseOptions(config: PublicRuntimeConfig["logger"]): {
+export declare function getBaseOptions(config: PublicRuntimeConfig["logger"], serverPathResolver?: (path: string) => string): {
     opts: LoggerOptions;
     browserOpts: LoggerOptions;
     transports: TransportMultiOptions;
     debug: {
         logPath: string;
+        resolvedLogPath: string;
         writeLevel: string;
         logLevel: string;
     };

package/dist/runtime/helpers/getBaseOptions.js

@@ -23,7 +23,7 @@ const levels = {
   }
 };
 const isElectronClient = typeof window !== "undefined" && "electron" in window && window.electron;
-export function getBaseOptions(config) {
+export function getBaseOptions(config, serverPathResolver) {
   if (isElectronClient) {
     delete config.logPath;
   }
@@ -64,9 +64,11 @@ export function getBaseOptions(config) {
     }
     delete clone._loadFromEnv;
   }
+  const resolvedLogPath = serverPathResolver?.(logPath) ?? logPath;
   return {
     debug: {
       logPath,
+      resolvedLogPath,
       writeLevel,
       logLevel
     },
@@ -77,6 +79,7 @@ export function getBaseOptions(config) {
       formatters: {
         bindings: () => ({})
       },
+      // @ts-expect-error https://github.com/pinojs/pino/issues/2260
       timestamp: pino.stdTimeFunctions.isoTime
     },
     browserOpts: {
@@ -99,7 +102,7 @@ export function getBaseOptions(config) {
           level: writeLevel,
           target: "pino/file",
           options: {
-            destination: logPath,
+            destination: resolvedLogPath,
             mkdir: true
           }
         },

package/dist/runtime/server/utils/useServerLogger.js

@@ -1,3 +1,2 @@
-import { useRuntimeConfig } from "#imports";
 import { createUseLogger } from "../../shared/createUseLogger.js";
-export const useServerLogger = createUseLogger(useRuntimeConfig);
+export const useServerLogger = createUseLogger({});

package/dist/runtime/shared/createUseLogger.d.ts

@@ -9,7 +9,7 @@ export type BaseLogger = Record<Levels, ((data: any) => void)> & {
     *
     * So they both create useLogger by passing in useRuntimeConfig how they can.
     */
-export declare function createUseLogger(rc: () => RuntimeConfig): ({ redirectTo, redirectAll }?: {
+export declare function createUseLogger(rc: () => RuntimeConfig, serverPathResolver?: (path: string) => string): ({ redirectTo, redirectAll }?: {
     redirectTo?: "electron";
     /**
      * Prefixes all messages not coming from main with `renderer:` so that they will be forwarded.

package/dist/runtime/shared/createUseLogger.js

@@ -1,7 +1,7 @@
 import { pino } from "pino";
 import { getBaseOptions } from "../helpers/getBaseOptions.js";
 const logger = {};
-export function createUseLogger(rc) {
+export function createUseLogger(rc, serverPathResolver) {
   let initiated = false;
   return function useLogger({
     redirectTo,
@@ -11,7 +11,7 @@ export function createUseLogger(rc) {
     if (!initiated) {
       initiated = true;
       const config = rc().public;
-      const { opts, transports, browserOpts, debug } = getBaseOptions(config.logger);
+      const { opts, transports, browserOpts, debug } = getBaseOptions(config.logger, serverPathResolver);
       let transport;
       if (import.meta.server) {
         transport = pino.transport(transports);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@witchcraft/nuxt-logger",
-	"version": "0.0.2",
+	"version": "0.0.4",
 	"description": "Nuxt module for logging.",
 	"repository": "witchcraftjs/nuxt-logger",
 	"license": "MIT",
@@ -41,7 +41,7 @@
 		"pino-pretty": "^11.2.2"
 	},
 	"dependencies": {
-		"@alanscodelog/tsconfigs": "^6.1.0",
+		"@alanscodelog/tsconfigs": "^6.2.0",
 		"@alanscodelog/utils": "^6.0.1",
 		"@nuxt/kit": "^4.0.3",
 		"defu": "latest",

package/src/module.ts

@@ -5,6 +5,7 @@ import {
 	addServerImportsDir,
 	createResolver,
 	defineNuxtModule,
+	resolveAlias,
 	resolvePath
 } from "@nuxt/kit"
 import { defu } from "defu"
@@ -106,10 +107,10 @@ export default defineNuxtModule<ModuleOptions>({
 	},
 	async setup(options, nuxt) {
 		const { resolve } = createResolver(import.meta.url)
-		options.devServerLogPath ??= await resolvePath("~~/logs/server.log", { alias: nuxt.options.alias })
+		options.devServerLogPath ??= path.relative(nuxt.options.rootDir, resolveAlias("~~/logs/server.log", nuxt.options.alias))
 		const maybeAppName = (nuxt.options.runtimeConfig.public as any)?.appInfo?.name
 		const appName = options.appName ?? maybeAppName ?? path.basename(await resolvePath("~~", { alias: nuxt.options.alias }))
-		options.serverLogPath ??= await resolvePath(`~~/logs/${appName}.log`, { alias: nuxt.options.alias })
+		options.serverLogPath ??= path.relative(nuxt.options.rootDir, resolveAlias(`~~/logs/${appName}.log`, nuxt.options.alias))
 		if (process.env.NODE_ENV === "development") {
 			if (!await fs.stat(options.devServerLogPath).then(() => true).catch(() => false)) {
 				await fs.mkdir(path.dirname(options.devServerLogPath), {

package/src/runtime/helpers/getBaseOptions.ts

@@ -31,13 +31,15 @@ const levels = {
 const isElectronClient = (typeof window !== "undefined" && "electron" in window && window.electron)
 
 export function getBaseOptions(
-	config: PublicRuntimeConfig["logger"]
+	config: PublicRuntimeConfig["logger"],
+	serverPathResolver?: (path: string) => string
 ): {
 	opts: LoggerOptions
 	browserOpts: LoggerOptions
 	transports: TransportMultiOptions
 	debug: {
 		logPath: string
+		resolvedLogPath: string
 		writeLevel: string
 		logLevel: string
 	}
@@ -100,9 +102,11 @@ export function getBaseOptions(
 		delete (clone as any)._loadFromEnv
 	}
 
+	const resolvedLogPath = serverPathResolver?.(logPath) ?? logPath
 	return {
 		debug: {
 			logPath,
+			resolvedLogPath,
 			writeLevel,
 			logLevel
 		},
@@ -113,6 +117,7 @@ export function getBaseOptions(
 			formatters: {
 				bindings: () => ({})
 			},
+			// @ts-expect-error https://github.com/pinojs/pino/issues/2260
 			timestamp: pino.stdTimeFunctions.isoTime
 		},
 		browserOpts: {
@@ -137,7 +142,7 @@ export function getBaseOptions(
 					level: writeLevel,
 					target: "pino/file",
 					options: {
-						destination: logPath,
+						destination: resolvedLogPath,
 						mkdir: true
 					}
 				},

package/src/runtime/server/utils/useServerLogger.ts

@@ -2,4 +2,5 @@ import { useRuntimeConfig } from "#imports"
 
 import { createUseLogger } from "../../shared/createUseLogger.js"
 
-export const useServerLogger = createUseLogger(useRuntimeConfig)
+export const useServerLogger = createUseLogger({
+})

package/src/runtime/shared/createUseLogger.ts

@@ -15,7 +15,8 @@ const logger: BaseLogger = {} as any
 	* So they both create useLogger by passing in useRuntimeConfig how they can.
 	*/
 export function createUseLogger(
-	rc: () => RuntimeConfig
+	rc: () => RuntimeConfig,
+	serverPathResolver?: (path: string) => string
 ) {
 	let initiated = false
 	return function useLogger({
@@ -37,7 +38,7 @@ export function createUseLogger(
 			initiated = true
 
 			const config = rc().public
-			const { opts, transports, browserOpts, debug } = getBaseOptions(config.logger)
+			const { opts, transports, browserOpts, debug } = getBaseOptions(config.logger, serverPathResolver)
 			let transport: any
 			if (import.meta.server) {
 				transport = pino.transport(transports)