fix: configure logging with log4js

package.json

@@ -51,6 +51,7 @@
   },
   "dependencies": {
     "fast-xml-parser": "^4.3.4",
+    "log4js": "^6.9.1",
     "tslib": "^2.6.2"
   }
 }

src/index.ts

@@ -1,2 +1,17 @@
+import * as log4js from "log4js";
+
 export { ReassembleXMLFileHandler } from "./service/reassembleXMLFileHandler";
 export { DisassembleXMLFileHandler } from "./service/disassembleXMLFileHandler";
+
+// Function to update the log level
+export function setLogLevel(level: string) {
+  log4js.getLogger().level = level;
+}
+
+// Expose the logger
+export const logger = log4js.getLogger();
+
+log4js.configure({
+  appenders: { disassemble: { type: "file", filename: "disassemble.log" } },
+  categories: { default: { appenders: ["disassemble"], level: "error" } },
+});

src/service/buildDisassembledFiles.ts

@@ -2,6 +2,7 @@
 
 import * as fs from "node:fs";
 import * as path from "node:path";
+import { logger } from "@src/index";
 import { XMLParser } from "fast-xml-parser";
 
 import { XML_HEADER } from "@src/helpers/constants";
@@ -89,7 +90,7 @@ export function buildDisassembledFiles(
     const leafOutputPath = path.join(metadataPath, `${baseName}.xml`);
     fs.writeFileSync(leafOutputPath, leafFile);
 
-    console.log(`All leaf elements saved to: ${leafOutputPath}`);
+    logger.debug(`All leaf elements saved to: ${leafOutputPath}`);
   }
 }
 
@@ -128,5 +129,5 @@ function buildNestedFile(
 
   // Write the XML content to the determined output path
   fs.writeFileSync(outputPath, decomposeFileContents);
-  console.log(`XML content saved to: ${outputPath}`);
+  logger.debug(`XML content saved to: ${outputPath}`);
 }

src/service/buildReassembledFiles.ts

@@ -1,6 +1,7 @@
 "use strict";
 
 import * as fs from "node:fs/promises";
+import { logger } from "@src/index";
 import { XML_HEADER, INDENT } from "@src/helpers/constants";
 
 export async function buildReassembledFile(
@@ -54,5 +55,5 @@ export async function buildReassembledFile(
     filePath,
     `${XML_HEADER}\n${openTag}${finalXmlContent}${closeTag}`,
   );
-  console.log(`Created reassembled file: ${filePath}`);
+  logger.debug(`Created reassembled file: ${filePath}`);
 }

src/service/disassembleXMLFileHandler.ts

@@ -1,5 +1,6 @@
 import * as fs from "node:fs/promises";
 import * as path from "node:path";
+import { logger } from "@src/index";
 import { INDENT } from "@src/helpers/constants";
 import { buildDisassembledFiles } from "@src/service/buildDisassembledFiles";
 
@@ -13,6 +14,7 @@ export class DisassembleXMLFileHandler {
     const fileStat = await fs.stat(xmlPath);
 
     if (!fileStat.isDirectory()) {
+      logger.error("The provided xmlPath is not a directory.");
       throw new Error("The provided xmlPath is not a directory.");
     }
     const files = await fs.readdir(xmlPath);
@@ -36,7 +38,7 @@ export class DisassembleXMLFileHandler {
     const { xmlPath, filePath, uniqueIdElements, purge } = xmlAttributes;
 
     if (filePath.endsWith(".xml")) {
-      console.log(`Parsing file: ${filePath}`);
+      logger.debug(`Parsing file: ${filePath}`);
       const xmlContent = await fs.readFile(filePath, "utf-8");
       const fullName = path.basename(filePath, path.extname(filePath));
       const baseName = fullName.split(".")[0];

src/service/reassembleXMLFileHandler.ts

@@ -1,5 +1,6 @@
 import * as fs from "node:fs/promises";
 import * as path from "node:path";
+import { logger } from "@src/index";
 import { XMLParser } from "fast-xml-parser";
 import { XmlElement, XML_PARSER_OPTION } from "@src/helpers/types";
 import { buildReassembledFile } from "@src/service/buildReassembledFiles";
@@ -83,6 +84,7 @@ export class ReassembleXMLFileHandler {
     const fileStat = await fs.stat(xmlPath);
 
     if (!fileStat.isDirectory()) {
+      logger.error("The provided xmlPath is not a directory.");
       throw new Error("The provided xmlPath is not a directory.");
     }
     // Process files directly inside the `xmlPath` directory