jet-logger 1.1.3 → 1.2.0

package/README.md

@@ -21,7 +21,8 @@ take priority over environment variables. Note that file writes happen asynchron
 
 - The four environment variables are:
     - `JET_LOGGER_MODE`: can be `'CONSOLE'`(default), `'FILE'`, `'CUSTOM'`, and `'OFF'`.
-    - `JET_LOGGER_FILEPATH`: the file-path for file mode. Default is _home_dir/jet-logger.log_.
+    - `JET_LOGGER_FILEPATH`: the file-path for file mode. Default is `_home_dir/jet-logger.log_`.
+    - `JET_LOGGER_FILEPATH_DATETIME`: prepend the log file name with the datetime. an be `'TRUE'` (default) or `'FALSE'`.
     - `JET_LOGGER_TIMESTAMP`: adds a timestamp next to each log. Can be `'TRUE'` (default) or `'FALSE'`.
     - `JET_LOGGER_FORMAT`: formats log as a line or JSON object. Can be `'LINE'` (default) or `'JSON'`.
 
@@ -114,7 +115,7 @@ const customSend: TCustomLogger = (timestamp: Date, level: string, content: any)
 }
 
 router.get('api/users', async (req: Request, res: Reponse) => {
-    const logger = JetLogger(LoggerModes.CUSTOM, '', true, customSend);
+    const logger = JetLogger(LoggerModes.CUSTOM, '', true, true, undefined, customSend);
     logger.rmTimestamp = true;
     logger.info(req.params.msg);
     return res.status(OK).json({

package/lib/index.d.ts

@@ -8,28 +8,13 @@ export declare enum Formats {
     Line = "LINE",
     Json = "JSON"
 }
-declare const levels: {
-    info: {
-        color: string;
-        prefix: string;
-    };
-    imp: {
-        color: string;
-        prefix: string;
-    };
-    warn: {
-        color: string;
-        prefix: string;
-    };
-    err: {
-        color: string;
-        prefix: string;
-    };
-};
-declare const _default: {
+declare type TJetLogger = ReturnType<typeof JetLogger>;
+export declare type TCustomLogger = (timestamp: Date, prefix: string, content: any) => void;
+export declare function JetLogger(mode?: LoggerModes, filepath?: string, filepathDatetime?: boolean, timestamp?: boolean, format?: Formats, customLogger?: TCustomLogger): {
     readonly settings: {
         readonly mode: LoggerModes;
-        readonly filePath: string;
+        readonly filepath: string;
+        readonly filepathDatetime: boolean;
         readonly timestamp: boolean;
         readonly format: Formats;
         readonly customLogger: TCustomLogger | undefined;
@@ -38,16 +23,16 @@ declare const _default: {
     readonly imp: typeof imp;
     readonly warn: typeof warn;
     readonly err: typeof err;
-    readonly printLog: typeof printLog;
 };
-export default _default;
-declare type TLevelProp = typeof levels[keyof typeof levels];
-declare type TJetLogger = ReturnType<typeof JetLogger>;
-export declare type TCustomLogger = (timestamp: Date, prefix: string, content: any) => void;
-export declare function JetLogger(mode?: LoggerModes, filePath?: string, timestamp?: boolean, format?: Formats, customLogger?: TCustomLogger): {
+declare function info(this: TJetLogger, content: any, printFull?: boolean): void;
+declare function imp(this: TJetLogger, content: any, printFull?: boolean): void;
+declare function warn(this: TJetLogger, content: any, printFull?: boolean): void;
+declare function err(this: TJetLogger, content: any, printFull?: boolean): void;
+declare const _default: {
     readonly settings: {
         readonly mode: LoggerModes;
-        readonly filePath: string;
+        readonly filepath: string;
+        readonly filepathDatetime: boolean;
         readonly timestamp: boolean;
         readonly format: Formats;
         readonly customLogger: TCustomLogger | undefined;
@@ -56,10 +41,5 @@ export declare function JetLogger(mode?: LoggerModes, filePath?: string, timesta
     readonly imp: typeof imp;
     readonly warn: typeof warn;
     readonly err: typeof err;
-    readonly printLog: typeof printLog;
 };
-declare function info(this: TJetLogger, content: any, printFull?: boolean): void;
-declare function imp(this: TJetLogger, content: any, printFull?: boolean): void;
-declare function warn(this: TJetLogger, content: any, printFull?: boolean): void;
-declare function err(this: TJetLogger, content: any, printFull?: boolean): void;
-declare function printLog(this: TJetLogger, content: any, printFull: boolean, level: TLevelProp): void;
+export default _default;

package/lib/index.js

@@ -43,24 +43,18 @@ var errors = {
         '"OFF", or "CONSOLE".'
 };
 var defaults = {
-    fileName: 'jet-logger.log',
+    filepath: 'jet-logger.log',
     mode: LoggerModes.Console,
     timestamp: true,
+    filepathDatetime: true,
     format: Formats.Line,
 };
-exports.default = JetLogger();
-function JetLogger(mode, filePath, timestamp, format, customLogger) {
-    return {
-        settings: getSettings(mode, filePath, timestamp, format, customLogger),
-        info: info,
-        imp: imp,
-        warn: warn,
-        err: err,
-        printLog: printLog,
-    };
+function JetLogger(mode, filepath, filepathDatetime, timestamp, format, customLogger) {
+    var settings = getSettings(mode, filepath, timestamp, filepathDatetime, format, customLogger);
+    return { settings: settings, info: info, imp: imp, warn: warn, err: err };
 }
 exports.JetLogger = JetLogger;
-function getSettings(mode, filePath, timestamp, format, customLogger) {
+function getSettings(mode, filepath, filepathDatetime, timestamp, format, customLogger) {
     if (!mode) {
         if (!!process.env.JET_LOGGER_MODE) {
             mode = process.env.JET_LOGGER_MODE.toUpperCase();
@@ -69,15 +63,24 @@ function getSettings(mode, filePath, timestamp, format, customLogger) {
             mode = defaults.mode;
         }
     }
-    if (!filePath) {
+    if (!filepath) {
         if (!!process.env.JET_LOGGER_FILEPATH) {
-            filePath = process.env.JET_LOGGER_FILEPATH;
+            filepath = process.env.JET_LOGGER_FILEPATH;
         }
         else {
-            filePath = defaults.fileName;
+            filepath = defaults.filepath;
         }
     }
-    if (!timestamp) {
+    if (filepathDatetime === undefined) {
+        if (!!process.env.JET_LOGGER_FILEPATH_DATETIME) {
+            filepathDatetime = (process.env.JET_LOGGER_FILEPATH_DATETIME.toUpperCase() ===
+                'TRUE');
+        }
+        else {
+            filepathDatetime = defaults.filepathDatetime;
+        }
+    }
+    if (timestamp === undefined) {
         if (!!process.env.JET_LOGGER_TIMESTAMP) {
             timestamp = (process.env.JET_LOGGER_TIMESTAMP.toUpperCase() === 'TRUE');
         }
@@ -95,26 +98,27 @@ function getSettings(mode, filePath, timestamp, format, customLogger) {
     }
     return {
         mode: mode,
-        filePath: filePath,
+        filepath: filepath,
+        filepathDatetime: filepathDatetime,
         timestamp: timestamp,
         format: format,
         customLogger: customLogger,
     };
 }
 function info(content, printFull) {
-    return this.printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, levels.info);
+    return printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, levels.info, this.settings);
 }
 function imp(content, printFull) {
-    return this.printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, levels.imp);
+    return printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, levels.imp, this.settings);
 }
 function warn(content, printFull) {
-    return this.printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, levels.warn);
+    return printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, levels.warn, this.settings);
 }
 function err(content, printFull) {
-    return this.printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, levels.err);
+    return printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, levels.err, this.settings);
 }
-function printLog(content, printFull, level) {
-    var _a = this.settings, mode = _a.mode, format = _a.format, timestamp = _a.timestamp, filePath = _a.filePath, customLogger = _a.customLogger;
+function printLog(content, printFull, level, settings) {
+    var mode = settings.mode, format = settings.format, timestamp = settings.timestamp, filepath = settings.filepath, filepathDatetime = settings.filepathDatetime, customLogger = settings.customLogger;
     if (mode === LoggerModes.Off) {
         return;
     }
@@ -150,9 +154,12 @@ function printLog(content, printFull, level) {
         console.log(colorFn(content));
     }
     else if (mode === LoggerModes.File) {
-        writeToFile(content + '\n', filePath).catch(function (err) {
-            console.log(err);
-        });
+        var filePathFinal = filepath;
+        if (filepathDatetime) {
+            filePathFinal = addDatetimeToFileName(filepath);
+        }
+        writeToFile(content + '\n', filePathFinal)
+            .catch(function (err) { return console.log(err); });
     }
     else if (mode === LoggerModes.Custom) {
         if (!!customLogger) {
@@ -166,6 +173,16 @@ function printLog(content, printFull, level) {
         throw Error(errors.modeErr);
     }
 }
+function addDatetimeToFileName(filePath) {
+    var dateStr = new Date().toISOString()
+        .split('-').join('')
+        .split(':').join('')
+        .slice(0, 15);
+    var filePathArr = filePath.split('/'), lastIdx = filePathArr.length - 1, fileName = filePathArr[lastIdx];
+    var fileNameNew = (dateStr + '_' + fileName);
+    filePathArr[lastIdx] = fileNameNew;
+    return filePathArr.join('/');
+}
 function writeToFile(content, filePath) {
     return new Promise(function (res, rej) {
         return fs_1.default.appendFile(filePath, content, function (err) {
@@ -173,3 +190,4 @@ function writeToFile(content, filePath) {
         });
     });
 }
+exports.default = JetLogger();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jet-logger",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "description": "A super quick, easy to setup logging tool for NodeJS/TypeScript.",
   "main": "./lib/index.js",
   "typings": "./lib/index.d.ts",