jet-logger 2.2.2 → 2.2.3

package/dist/cjs/jetLogger.js

@@ -1,59 +1,59 @@
 import colors from 'colors';
 import fs from 'fs';
 import util from 'util';
-const LOGGER_MODES = {
-    Console: 'CONSOLE',
-    File: 'FILE',
-    Custom: 'CUSTOM',
-    Off: 'OFF',
+const Modes = {
+    CONSOLE: 'console',
+    FILE: 'file',
+    CUSTOM: 'custom',
+    OFF: 'off',
 };
-const FORMATS = {
-    Line: 'LINE',
-    Json: 'JSON',
+const Formats = {
+    LINE: 'line',
+    JSON: 'json',
 };
-const LEVELS = {
+const Levels = {
     Info: {
-        Color: 'green',
-        Prefix: 'INFO',
+        COLOR: 'green',
+        PREFIX: 'INFO',
     },
     Important: {
-        Color: 'magenta',
-        Prefix: 'IMPORTANT',
+        COLOR: 'magenta',
+        PREFIX: 'IMPORTANT',
     },
     Warning: {
-        Color: 'yellow',
-        Prefix: 'WARNING',
+        COLOR: 'yellow',
+        PREFIX: 'WARNING',
     },
     Error: {
-        Color: 'red',
-        Prefix: 'ERROR',
+        COLOR: 'red',
+        PREFIX: 'ERROR',
     },
 };
-const DEFAULTS = {
-    mode: LOGGER_MODES.Console,
-    filePath: 'jet-logger.log',
-    timestamp: true,
-    format: FORMATS.Line,
-    customLogFn: () => ({}),
+const Defaults = {
+    MODE: Modes.CONSOLE,
+    FILE_PATH: 'jet-logger.log',
+    TIMESTAMP: true,
+    FORMAT: Formats.LINE,
+    CUSTOM_LOGGER_FUNCTION: () => ({}),
 };
 const Errors = {
-    CustomLogger: 'Custom logger mode set to true, but no custom logger was provided.',
-    Mode: 'The correct logger mode was not specified: Must be "CUSTOM", "FILE", ' +
-        '"OFF", or "CONSOLE".',
+    CUSTOM_LOGGER: 'Custom logger mode set to true, but no custom logger was provided.',
+    MODE: 'The correct logger mode was not specified: Must be "custom", "file", ' +
+        '"off", or "console".',
 };
 export const JetLogger = {
-    Modes: LOGGER_MODES,
-    Formats: FORMATS,
+    Modes,
+    Formats,
 };
 export function jetLogger(options) {
-    let mode = DEFAULTS.mode, filePath = DEFAULTS.filePath, timestamp = DEFAULTS.timestamp, format = DEFAULTS.format, customLogFn = DEFAULTS.customLogFn;
+    let mode = Defaults.MODE, filePath = Defaults.FILE_PATH, timestamp = Defaults.TIMESTAMP, format = Defaults.FORMAT, customLogFn = Defaults.CUSTOM_LOGGER_FUNCTION;
     if (options?.mode !== undefined) {
         mode = options.mode;
     }
     else if (!!process.env.JET_LOGGER_MODE) {
-        mode = process.env.JET_LOGGER_MODE.toUpperCase();
+        mode = process.env.JET_LOGGER_MODE.toLowerCase();
     }
-    if (mode === LOGGER_MODES.Off) {
+    if (mode === Modes.OFF) {
         return {
             info: (_, __) => ({}),
             imp: (_, __) => ({}),
@@ -61,18 +61,18 @@ export function jetLogger(options) {
             err: (_, __) => ({}),
         };
     }
-    if (mode === LOGGER_MODES.Custom) {
+    if (mode === Modes.CUSTOM) {
         if (options?.customLogger !== undefined) {
             customLogFn = options.customLogger;
         }
         if (!customLogFn) {
-            throw Error(Errors.CustomLogger);
+            throw Error(Errors.CUSTOM_LOGGER);
         }
         return {
-            info: setupPrintWithCustomLogger(LEVELS.Info, customLogFn),
-            imp: setupPrintWithCustomLogger(LEVELS.Important, customLogFn),
-            warn: setupPrintWithCustomLogger(LEVELS.Warning, customLogFn),
-            err: setupPrintWithCustomLogger(LEVELS.Error, customLogFn),
+            info: setupPrintWithCustomLogger(Levels.Info, customLogFn),
+            imp: setupPrintWithCustomLogger(Levels.Important, customLogFn),
+            warn: setupPrintWithCustomLogger(Levels.Warning, customLogFn),
+            err: setupPrintWithCustomLogger(Levels.Error, customLogFn),
         };
     }
     if (options?.filepath !== undefined) {
@@ -86,45 +86,45 @@ export function jetLogger(options) {
     }
     else if (!!process.env.JET_LOGGER_TIMESTAMP) {
         const envVar = process.env.JET_LOGGER_TIMESTAMP;
-        timestamp = envVar.toUpperCase() === 'TRUE';
+        timestamp = envVar.toLowerCase() === 'true';
     }
     if (options?.format !== undefined) {
         format = options.format;
     }
     else if (!!process.env.JET_LOGGER_FORMAT) {
-        format = process.env.JET_LOGGER_FORMAT.toUpperCase();
+        format = process.env.JET_LOGGER_FORMAT.toLowerCase();
     }
     let formatter = () => '';
-    if (format === FORMATS.Line) {
+    if (format === Formats.LINE) {
         formatter = setupLineFormatter(timestamp);
     }
-    else if (format === FORMATS.Json) {
+    else if (format === Formats.JSON) {
         formatter = setupJsonFormatter(timestamp);
     }
-    if (mode === LOGGER_MODES.File) {
+    if (mode === Modes.FILE) {
         let filePathDatetime = true;
         if (options?.filepathDatetimeParam !== undefined) {
             filePathDatetime = options.filepathDatetimeParam;
         }
         else if (!!process.env.JET_LOGGER_FILEPATH_DATETIME) {
             const envVar = process.env.JET_LOGGER_FILEPATH_DATETIME;
-            filePathDatetime = envVar.toUpperCase() === 'TRUE';
+            filePathDatetime = envVar.toLowerCase() === 'true';
         }
         if (filePathDatetime) {
             filePath = addDatetimeToFileName(filePath);
         }
         return {
-            info: setupPrintToFile(LEVELS.Info, formatter, filePath),
-            imp: setupPrintToFile(LEVELS.Important, formatter, filePath),
-            warn: setupPrintToFile(LEVELS.Warning, formatter, filePath),
-            err: setupPrintToFile(LEVELS.Error, formatter, filePath),
+            info: setupPrintToFile(Levels.Info, formatter, filePath),
+            imp: setupPrintToFile(Levels.Important, formatter, filePath),
+            warn: setupPrintToFile(Levels.Warning, formatter, filePath),
+            err: setupPrintToFile(Levels.Error, formatter, filePath),
         };
     }
     return {
-        info: setupPrintToConsole(LEVELS.Info, formatter),
-        imp: setupPrintToConsole(LEVELS.Important, formatter),
-        warn: setupPrintToConsole(LEVELS.Warning, formatter),
-        err: setupPrintToConsole(LEVELS.Error, formatter),
+        info: setupPrintToConsole(Levels.Info, formatter),
+        imp: setupPrintToConsole(Levels.Important, formatter),
+        warn: setupPrintToConsole(Levels.Warning, formatter),
+        err: setupPrintToConsole(Levels.Error, formatter),
     };
 }
 function setupPrintWithCustomLogger(level, customLogFn) {
@@ -136,19 +136,19 @@ function setupPrintWithCustomLogger(level, customLogFn) {
         else {
             contentNew = String(content);
         }
-        return customLogFn(new Date(), level.Prefix, contentNew);
+        return customLogFn(new Date(), level.PREFIX, contentNew);
     };
 }
 function setupLineFormatter(timestamp) {
     if (timestamp) {
         return (content, level) => {
-            const contentNew = level.Prefix + ': ' + content, time = '[' + new Date().toISOString() + '] ';
+            const contentNew = level.PREFIX + ': ' + content, time = '[' + new Date().toISOString() + '] ';
             return time + contentNew;
         };
     }
     else {
         return (content, level) => {
-            return level.Prefix + ': ' + content;
+            return level.PREFIX + ': ' + content;
         };
     }
 }
@@ -156,7 +156,7 @@ function setupJsonFormatter(timestamp) {
     if (timestamp) {
         return (content, level) => {
             const json = {
-                level: level.Prefix,
+                level: level.PREFIX,
                 message: content,
             };
             json.timestamp = new Date().toISOString();
@@ -166,7 +166,7 @@ function setupJsonFormatter(timestamp) {
     else {
         return (content, level) => {
             const json = {
-                level: level.Prefix,
+                level: level.PREFIX,
                 message: content,
             };
             return JSON.stringify(json);
@@ -183,7 +183,7 @@ function setupPrintToFile(level, formatter, filePath) {
             contentNew = String(content);
         }
         contentNew = formatter(contentNew, level);
-        fs.appendFile(filePath, contentNew, (err) => {
+        fs.appendFile(filePath, contentNew + '\n', (err) => {
             if (!!err) {
                 console.error(err);
             }
@@ -199,7 +199,7 @@ function setupPrintToConsole(level, formatter) {
         else {
             contentNew = String(content);
         }
-        const colorFn = colors[level.Color];
+        const colorFn = colors[level.COLOR];
         contentNew = formatter(contentNew, level);
         console.log(colorFn(contentNew));
     };

package/dist/esm/jetLogger.js

@@ -1,59 +1,59 @@
 import colors from 'colors';
 import fs from 'fs';
 import util from 'util';
-const LOGGER_MODES = {
-    Console: 'CONSOLE',
-    File: 'FILE',
-    Custom: 'CUSTOM',
-    Off: 'OFF',
+const Modes = {
+    CONSOLE: 'console',
+    FILE: 'file',
+    CUSTOM: 'custom',
+    OFF: 'off',
 };
-const FORMATS = {
-    Line: 'LINE',
-    Json: 'JSON',
+const Formats = {
+    LINE: 'line',
+    JSON: 'json',
 };
-const LEVELS = {
+const Levels = {
     Info: {
-        Color: 'green',
-        Prefix: 'INFO',
+        COLOR: 'green',
+        PREFIX: 'INFO',
     },
     Important: {
-        Color: 'magenta',
-        Prefix: 'IMPORTANT',
+        COLOR: 'magenta',
+        PREFIX: 'IMPORTANT',
     },
     Warning: {
-        Color: 'yellow',
-        Prefix: 'WARNING',
+        COLOR: 'yellow',
+        PREFIX: 'WARNING',
     },
     Error: {
-        Color: 'red',
-        Prefix: 'ERROR',
+        COLOR: 'red',
+        PREFIX: 'ERROR',
     },
 };
-const DEFAULTS = {
-    mode: LOGGER_MODES.Console,
-    filePath: 'jet-logger.log',
-    timestamp: true,
-    format: FORMATS.Line,
-    customLogFn: () => ({}),
+const Defaults = {
+    MODE: Modes.CONSOLE,
+    FILE_PATH: 'jet-logger.log',
+    TIMESTAMP: true,
+    FORMAT: Formats.LINE,
+    CUSTOM_LOGGER_FUNCTION: () => ({}),
 };
 const Errors = {
-    CustomLogger: 'Custom logger mode set to true, but no custom logger was provided.',
-    Mode: 'The correct logger mode was not specified: Must be "CUSTOM", "FILE", ' +
-        '"OFF", or "CONSOLE".',
+    CUSTOM_LOGGER: 'Custom logger mode set to true, but no custom logger was provided.',
+    MODE: 'The correct logger mode was not specified: Must be "custom", "file", ' +
+        '"off", or "console".',
 };
 export const JetLogger = {
-    Modes: LOGGER_MODES,
-    Formats: FORMATS,
+    Modes,
+    Formats,
 };
 export function jetLogger(options) {
-    let mode = DEFAULTS.mode, filePath = DEFAULTS.filePath, timestamp = DEFAULTS.timestamp, format = DEFAULTS.format, customLogFn = DEFAULTS.customLogFn;
+    let mode = Defaults.MODE, filePath = Defaults.FILE_PATH, timestamp = Defaults.TIMESTAMP, format = Defaults.FORMAT, customLogFn = Defaults.CUSTOM_LOGGER_FUNCTION;
     if (options?.mode !== undefined) {
         mode = options.mode;
     }
     else if (!!process.env.JET_LOGGER_MODE) {
-        mode = process.env.JET_LOGGER_MODE.toUpperCase();
+        mode = process.env.JET_LOGGER_MODE.toLowerCase();
     }
-    if (mode === LOGGER_MODES.Off) {
+    if (mode === Modes.OFF) {
         return {
             info: (_, __) => ({}),
             imp: (_, __) => ({}),
@@ -61,18 +61,18 @@ export function jetLogger(options) {
             err: (_, __) => ({}),
         };
     }
-    if (mode === LOGGER_MODES.Custom) {
+    if (mode === Modes.CUSTOM) {
         if (options?.customLogger !== undefined) {
             customLogFn = options.customLogger;
         }
         if (!customLogFn) {
-            throw Error(Errors.CustomLogger);
+            throw Error(Errors.CUSTOM_LOGGER);
         }
         return {
-            info: setupPrintWithCustomLogger(LEVELS.Info, customLogFn),
-            imp: setupPrintWithCustomLogger(LEVELS.Important, customLogFn),
-            warn: setupPrintWithCustomLogger(LEVELS.Warning, customLogFn),
-            err: setupPrintWithCustomLogger(LEVELS.Error, customLogFn),
+            info: setupPrintWithCustomLogger(Levels.Info, customLogFn),
+            imp: setupPrintWithCustomLogger(Levels.Important, customLogFn),
+            warn: setupPrintWithCustomLogger(Levels.Warning, customLogFn),
+            err: setupPrintWithCustomLogger(Levels.Error, customLogFn),
         };
     }
     if (options?.filepath !== undefined) {
@@ -86,45 +86,45 @@ export function jetLogger(options) {
     }
     else if (!!process.env.JET_LOGGER_TIMESTAMP) {
         const envVar = process.env.JET_LOGGER_TIMESTAMP;
-        timestamp = envVar.toUpperCase() === 'TRUE';
+        timestamp = envVar.toLowerCase() === 'true';
     }
     if (options?.format !== undefined) {
         format = options.format;
     }
     else if (!!process.env.JET_LOGGER_FORMAT) {
-        format = process.env.JET_LOGGER_FORMAT.toUpperCase();
+        format = process.env.JET_LOGGER_FORMAT.toLowerCase();
     }
     let formatter = () => '';
-    if (format === FORMATS.Line) {
+    if (format === Formats.LINE) {
         formatter = setupLineFormatter(timestamp);
     }
-    else if (format === FORMATS.Json) {
+    else if (format === Formats.JSON) {
         formatter = setupJsonFormatter(timestamp);
     }
-    if (mode === LOGGER_MODES.File) {
+    if (mode === Modes.FILE) {
         let filePathDatetime = true;
         if (options?.filepathDatetimeParam !== undefined) {
             filePathDatetime = options.filepathDatetimeParam;
         }
         else if (!!process.env.JET_LOGGER_FILEPATH_DATETIME) {
             const envVar = process.env.JET_LOGGER_FILEPATH_DATETIME;
-            filePathDatetime = envVar.toUpperCase() === 'TRUE';
+            filePathDatetime = envVar.toLowerCase() === 'true';
         }
         if (filePathDatetime) {
             filePath = addDatetimeToFileName(filePath);
         }
         return {
-            info: setupPrintToFile(LEVELS.Info, formatter, filePath),
-            imp: setupPrintToFile(LEVELS.Important, formatter, filePath),
-            warn: setupPrintToFile(LEVELS.Warning, formatter, filePath),
-            err: setupPrintToFile(LEVELS.Error, formatter, filePath),
+            info: setupPrintToFile(Levels.Info, formatter, filePath),
+            imp: setupPrintToFile(Levels.Important, formatter, filePath),
+            warn: setupPrintToFile(Levels.Warning, formatter, filePath),
+            err: setupPrintToFile(Levels.Error, formatter, filePath),
         };
     }
     return {
-        info: setupPrintToConsole(LEVELS.Info, formatter),
-        imp: setupPrintToConsole(LEVELS.Important, formatter),
-        warn: setupPrintToConsole(LEVELS.Warning, formatter),
-        err: setupPrintToConsole(LEVELS.Error, formatter),
+        info: setupPrintToConsole(Levels.Info, formatter),
+        imp: setupPrintToConsole(Levels.Important, formatter),
+        warn: setupPrintToConsole(Levels.Warning, formatter),
+        err: setupPrintToConsole(Levels.Error, formatter),
     };
 }
 function setupPrintWithCustomLogger(level, customLogFn) {
@@ -136,19 +136,19 @@ function setupPrintWithCustomLogger(level, customLogFn) {
         else {
             contentNew = String(content);
         }
-        return customLogFn(new Date(), level.Prefix, contentNew);
+        return customLogFn(new Date(), level.PREFIX, contentNew);
     };
 }
 function setupLineFormatter(timestamp) {
     if (timestamp) {
         return (content, level) => {
-            const contentNew = level.Prefix + ': ' + content, time = '[' + new Date().toISOString() + '] ';
+            const contentNew = level.PREFIX + ': ' + content, time = '[' + new Date().toISOString() + '] ';
             return time + contentNew;
         };
     }
     else {
         return (content, level) => {
-            return level.Prefix + ': ' + content;
+            return level.PREFIX + ': ' + content;
         };
     }
 }
@@ -156,7 +156,7 @@ function setupJsonFormatter(timestamp) {
     if (timestamp) {
         return (content, level) => {
             const json = {
-                level: level.Prefix,
+                level: level.PREFIX,
                 message: content,
             };
             json.timestamp = new Date().toISOString();
@@ -166,7 +166,7 @@ function setupJsonFormatter(timestamp) {
     else {
         return (content, level) => {
             const json = {
-                level: level.Prefix,
+                level: level.PREFIX,
                 message: content,
             };
             return JSON.stringify(json);
@@ -183,7 +183,7 @@ function setupPrintToFile(level, formatter, filePath) {
             contentNew = String(content);
         }
         contentNew = formatter(contentNew, level);
-        fs.appendFile(filePath, contentNew, (err) => {
+        fs.appendFile(filePath, contentNew + '\n', (err) => {
             if (!!err) {
                 console.error(err);
             }
@@ -199,7 +199,7 @@ function setupPrintToConsole(level, formatter) {
         else {
             contentNew = String(content);
         }
-        const colorFn = colors[level.Color];
+        const colorFn = colors[level.COLOR];
         contentNew = formatter(contentNew, level);
         console.log(colorFn(contentNew));
     };

package/dist/types/jetLogger.d.ts

@@ -1,37 +1,37 @@
 /******************************************************************************
                                  Constants
 ******************************************************************************/
-declare const LOGGER_MODES: {
-    readonly Console: "CONSOLE";
-    readonly File: "FILE";
-    readonly Custom: "CUSTOM";
-    readonly Off: "OFF";
+declare const Modes: {
+    readonly CONSOLE: "console";
+    readonly FILE: "file";
+    readonly CUSTOM: "custom";
+    readonly OFF: "off";
 };
-declare const FORMATS: {
-    readonly Line: "LINE";
-    readonly Json: "JSON";
+declare const Formats: {
+    readonly LINE: "line";
+    readonly JSON: "json";
 };
 export declare const JetLogger: {
     readonly Modes: {
-        readonly Console: "CONSOLE";
-        readonly File: "FILE";
-        readonly Custom: "CUSTOM";
-        readonly Off: "OFF";
+        readonly CONSOLE: "console";
+        readonly FILE: "file";
+        readonly CUSTOM: "custom";
+        readonly OFF: "off";
     };
     readonly Formats: {
-        readonly Line: "LINE";
-        readonly Json: "JSON";
+        readonly LINE: "line";
+        readonly JSON: "json";
     };
 };
 /******************************************************************************
                                   Types
 ******************************************************************************/
-type LoggerModes = (typeof LOGGER_MODES)[keyof typeof LOGGER_MODES];
-type Formats = (typeof FORMATS)[keyof typeof FORMATS];
+type Modes = (typeof Modes)[keyof typeof Modes];
+type Formats = (typeof Formats)[keyof typeof Formats];
 type LogFunction = (content: unknown, printFull?: boolean) => void;
 export type CustomLogger = (timestamp: Date, prefix: string, content: unknown) => void;
 interface Options {
-    mode?: LoggerModes;
+    mode?: Modes;
     filepath?: string;
     filepathDatetimeParam?: boolean;
     timestamp?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jet-logger",
-  "version": "2.2.2",
+  "version": "2.2.3",
   "description": "A super quick, easy to setup logging tool for NodeJS/TypeScript.",
   "type": "module",
   "main": "./dist/cjs/index.js",