feat: add winston logger (#143)

* feat: add winston logger

* refactor: improve usage of winston logger overide, remove start.js file and logger.js file used for override

* fix: formatting

* fix: formatting

packages/log/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@homarr/log",
+  "private": true,
+  "version": "0.1.0",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.mjs"
+    },
+    "./override": "./src/override.cjs"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "src/*"
+      ]
+    }
+  },
+  "license": "MIT",
+  "scripts": {
+    "clean": "rm -rf .turbo node_modules",
+    "lint": "eslint .",
+    "format": "prettier --check . --ignore-path ../../.gitignore",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "winston": "3.11.0"
+  },
+  "devDependencies": {
+    "@homarr/eslint-config": "workspace:^0.2.0",
+    "@homarr/prettier-config": "workspace:^0.1.0",
+    "@homarr/tsconfig": "workspace:^0.1.0",
+    "eslint": "^8.56.0",
+    "typescript": "^5.3.3"
+  },
+  "eslintConfig": {
+    "extends": [
+      "@homarr/eslint-config/base"
+    ]
+  },
+  "prettier": "@homarr/prettier-config"
+}

packages/log/src/index.d.ts

@@ -0,0 +1,4 @@
+import type { Logger } from "winston";
+
+// The following is just to make prettier happy
+export const logger: Logger = undefined as unknown as Logger;

packages/log/src/index.mjs

@@ -0,0 +1,16 @@
+import winston, { format, transports } from "winston";
+
+const logMessageFormat = format.printf(({ level, message, timestamp }) => {
+  return `${timestamp} ${level}: ${message}`;
+});
+
+const logger = winston.createLogger({
+  format: format.combine(
+    format.colorize(),
+    format.timestamp(),
+    logMessageFormat,
+  ),
+  transports: [new transports.Console()],
+});
+
+export { logger };

packages/log/src/override.cjs

@@ -0,0 +1,45 @@
+void (async () => {
+  const { logger } = await import("./index.mjs");
+
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-var-requires
+  const nextLogger = require("next/dist/build/output/log");
+
+  const getWinstonMethodForConsole = (consoleMethod) => {
+    switch (consoleMethod) {
+      case "error":
+        return (...messages) => logger.error(messages.join(" "));
+      case "warn":
+        return (...messages) => logger.warn(messages.join(" "));
+      case "debug":
+        return (...messages) => logger.debug(messages.join(" "));
+      case "log":
+      case "info":
+      default:
+        return (...messages) => logger.info(messages.join(" "));
+    }
+  };
+
+  const consoleMethods = ["log", "debug", "info", "warn", "error"];
+  consoleMethods.forEach((method) => {
+    console[method] = getWinstonMethodForConsole(method);
+  });
+
+  const getWinstonMethodForNext = (nextMethod) => {
+    switch (nextMethod) {
+      case "error":
+        return (...messages) => logger.error(messages.join(" "));
+      case "warn":
+        return (...messages) => logger.warn(messages.join(" "));
+      case "trace":
+        return (...messages) => logger.info(messages.join(" "));
+      default:
+        return (...messages) => logger.info(messages.join(" "));
+    }
+  };
+
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access
+  Object.keys(nextLogger.prefixes).forEach((method) => {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+    nextLogger[method] = getWinstonMethodForNext(method);
+  });
+})();

packages/log/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@homarr/tsconfig/base.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json"
+  },
+  "include": ["*.ts", "src", "index.mjs"],
+  "exclude": ["node_modules"]
+}