add enableFileAndLine

Author: tigercosmos

README.md

@@ -99,6 +99,21 @@ fileStream.close()
 
 You can use `less -R test.log` to see the result.
 
+### `enableFileAndLine()`
+
+Print the filename and line information in the logs. Note that this may increase a little performance overhead.
+
+```js
+logger.enableFileAndLine(true /* enable */);
+
+logger.debug('This log should include file and line information.');
+// 2025-07-23T18:43:27.199Z[/Users/tigercosmos/node-color-log/index.js:157] [DEBUG] This log should include file and line information.
+
+logger.enableFileAndLine(true /* enable */, true /* short file name */);
+logger.debug('This log should include file and line information.');
+// 2025-07-23T18:43:27.200Z[index.js:157:33:157] [DEBUG] This log should include file and line information.
+```
+
 ### `fontColorLog()`, `bgColorLog()`, `colorLog()`
 
 - `message` here must be a string.

change.log.md

@@ -1,3 +1,6 @@
+13.0.0
+- add `enableFileAndLine`
+
 12.0.1
 - added tests.
 

index.d.ts

@@ -32,6 +32,8 @@ declare class Logger {
 
     setLevelColor(): void;
 
+    enableFileAndLine(enable: boolean, isShortFile?: boolean): void;
+
     isLevelValid(level: types.LEVEL): boolean;
 
     isAllowedLevel(level: types.LEVEL): boolean;
@@ -47,27 +49,27 @@ declare class Logger {
     setDate(callback: Function): void;
 
     getDate(): string;
-    
+
     color(ticket: types.COLOR): Logger;
-    
+
     bgColor(ticket: types.COLOR): Logger;
-    
+
     bold(): Logger;
-    
+
     dim(): Logger;
-    
+
     underscore(): Logger;
-    
+
     strikethrough(): Logger;
-    
+
     reverse(): Logger;
-    
+
     italic(): Logger;
-    
+
     fontColorLog(ticket: types.COLOR, text: string, setting?: settingObject): void;
-    
+
     bgColorLog(ticket: types.COLOR, text: string, setting?: settingObject): void;
-    
+
     colorLog(ticketObj: ticketObject, text: string, setting?: settingObject): void;
 
     log(...args: any[]): Logger;

index.js

@@ -55,6 +55,11 @@ class Logger {
         this._getDate = () => (new Date()).toISOString();
 
         this._customizedConsole = console;
+
+        this._enableFileAndLine = {
+            enable: false,
+            isShortFile: false,
+        };
     }
 
     createNamedLogger(name) {
@@ -94,6 +99,15 @@ class Logger {
         return this.level ? LEVELS.indexOf(this.level) <= LEVELS.indexOf(level) : true
     }
 
+    enableFileAndLine(enable, isShortFile = false) {
+        if (typeof enable === 'boolean') {
+            this._enableFileAndLine.enable = enable;
+            this._enableFileAndLine.isShortFile = isShortFile;
+        } else {
+            console.error("node-color-log warning: enableFileAndLine should be a boolean value.");
+        }
+    }
+
     log(...args) {
         this.append(...args);
         if (!this.noColor) {
@@ -134,11 +148,19 @@ class Logger {
     }
 
     getPrefix() {
+        let prefix = `${this._getDate()}`;
+
         if (this.name) {
-            return `${this._getDate()} [${this.name}]`;
-        } else {
-            return this._getDate();
+            prefix += ` [${this.name}]`;
+        }
+        if (this._enableFileAndLine.enable) {
+            const fileAndLine = getFileAndLine(this._enableFileAndLine.isShortFile);
+            if (fileAndLine) {
+                prefix += `[${fileAndLine}]`;
+            }
         }
+
+        return prefix;
     }
 
     color(ticket) {
@@ -376,5 +398,32 @@ class Logger {
     }
 }
 
+function getFileAndLine(isShortFile = false) {
+    const e = new Error();
+    const line = e.stack.split('\n')[2]; // 3rd line: caller
+
+    // find ( and ) in the line from the end
+    let start = line.lastIndexOf('(');
+    let end = line.lastIndexOf(')');
+    if (start === -1 || end === -1 || start >= end) {
+        return '';
+    }
+    // Extract the file and line number
+    const fileAndLine = line.substring(start + 1, end);
+
+    if (isShortFile) {
+        const fileName = fileAndLine.split('/').pop(); // Get the last part of the path
+        return `${fileName}:${fileAndLine.split(':')[1]}`; // Return file name and line number
+    }
+
+    // Split by : to get the file path and line number
+    const parts = fileAndLine.split(':');
+    if (parts.length < 2) {
+        return '';
+    }
+    // Return the file path and line number
+    return `${parts[0]}:${parts[1]}`;
+}
+
 const logger = new Logger();
-module.exports = logger;
+module.exports = logger;

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "node-color-log",
-  "version": "12.0.1",
+  "version": "13.0.0",
   "description": "The more powerful JavaScript logger for NodeJS and browsers.",
   "main": "index.js",
   "scripts": {

package.json

@@ -0,0 +1,16 @@
+const logger = require('../index');
+
+logger.log('****************');
+logger.log('*** Test File and Line ***');
+logger.log('****************');
+
+logger.enableFileAndLine(true);
+
+logger.debug('This log should include file and line information.');
+logger.debug('Another log with file and line information.');
+
+
+logger.enableFileAndLine(true, true);
+
+logger.debug('This log should include file and line information.');
+logger.debug('Another log with file and line information.');

test/test5.js

@@ -8,4 +8,7 @@ node test\test3.js
 $env:LOGGER = "info"
 node test\test4.js
 
+$env:LOGGER = "debug"
+node test\test5.js
+
 node test\test_stream.js

test/test_main.ps1

@@ -8,4 +8,6 @@ node test/test3.js
 
 LOGGER=info node test/test4.js
 
+node test/test5.js
+
 node test/test_stream.js