jet-logger 2.1.0 → 2.2.0

package/dist/cjs/index.js

@@ -1 +1 @@
-export { LoggerModes, Formats, JetLogger, default as default, } from './JetLogger.js';
+export { JetLogger, jetLogger, default, } from './jetLogger.js';

package/dist/cjs/jetLogger.js

@@ -0,0 +1,285 @@
+/* eslint-disable no-console */
+/* eslint-disable no-process-env */
+import colors from 'colors';
+import fs from 'fs';
+import util from 'util';
+/******************************************************************************
+                                 Constants
+******************************************************************************/
+// Options for printing a log.
+const LOGGER_MODES = {
+    Console: 'CONSOLE',
+    File: 'FILE',
+    Custom: 'CUSTOM',
+    Off: 'OFF',
+};
+// Log formats
+const FORMATS = {
+    Line: 'LINE',
+    Json: 'JSON',
+};
+// Note colors here need be a color from
+// the colors library above.
+const LEVELS = {
+    Info: {
+        Color: 'green',
+        Prefix: 'INFO',
+    },
+    Important: {
+        Color: 'magenta',
+        Prefix: 'IMPORTANT',
+    },
+    Warning: {
+        Color: 'yellow',
+        Prefix: 'WARNING',
+    },
+    Error: {
+        Color: 'red',
+        Prefix: 'ERROR',
+    },
+};
+const DEFAULTS = {
+    mode: LOGGER_MODES.Console,
+    filePath: 'jet-logger.log',
+    timestamp: true,
+    format: FORMATS.Line,
+    customLogFn: () => ({}),
+};
+// Errors
+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".',
+};
+export const JetLogger = {
+    Modes: LOGGER_MODES,
+    Formats: FORMATS,
+    instanceOf,
+};
+const kJetLogger = Symbol('k-jet-logger');
+/******************************************************************************
+                               Functions
+******************************************************************************/
+/**
+ * Default function
+ */
+export function jetLogger(options) {
+    let mode = DEFAULTS.mode, filePath = DEFAULTS.filePath, timestamp = DEFAULTS.timestamp, format = DEFAULTS.format, customLogFn = DEFAULTS.customLogFn;
+    // Setup the mode
+    if (options?.mode !== undefined) {
+        mode = options.mode;
+    }
+    else if (!!process.env.JET_LOGGER_MODE) {
+        mode = process.env.JET_LOGGER_MODE.toUpperCase();
+    }
+    // ** Logger Mode Off ** //
+    if (mode === LOGGER_MODES.Off) {
+        return {
+            info: (_, __) => ({}),
+            imp: (_, __) => ({}),
+            warn: (_, __) => ({}),
+            err: (_, __) => ({}),
+            [kJetLogger]: true,
+        };
+    }
+    // ** Custom Logger Function ** //
+    if (mode === LOGGER_MODES.Custom) {
+        if (options?.customLogger !== undefined) {
+            customLogFn = options.customLogger;
+        }
+        if (!customLogFn) {
+            throw Error(Errors.CustomLogger);
+        }
+        return {
+            info: setupPrintWithCustomLogger(LEVELS.Info, customLogFn),
+            imp: setupPrintWithCustomLogger(LEVELS.Important, customLogFn),
+            warn: setupPrintWithCustomLogger(LEVELS.Warning, customLogFn),
+            err: setupPrintWithCustomLogger(LEVELS.Error, customLogFn),
+            [kJetLogger]: true,
+        };
+    }
+    // Filepath
+    if (options?.filepath !== undefined) {
+        filePath = options.filepath;
+    }
+    else if (!!process.env.JET_LOGGER_FILEPATH) {
+        filePath = process.env.JET_LOGGER_FILEPATH;
+    }
+    // Timestamp
+    if (options?.timestamp !== undefined) {
+        timestamp = options.timestamp;
+    }
+    else if (!!process.env.JET_LOGGER_TIMESTAMP) {
+        const envVar = process.env.JET_LOGGER_TIMESTAMP;
+        timestamp = envVar.toUpperCase() === 'TRUE';
+    }
+    // Format
+    if (options?.format !== undefined) {
+        format = options.format;
+    }
+    else if (!!process.env.JET_LOGGER_FORMAT) {
+        format = process.env.JET_LOGGER_FORMAT.toUpperCase();
+    }
+    // Setup the formatter
+    let formatter = () => '';
+    if (format === FORMATS.Line) {
+        formatter = setupLineFormatter(timestamp);
+    }
+    else if (format === FORMATS.Json) {
+        formatter = setupJsonFormatter(timestamp);
+    }
+    // ** Print to File ** //
+    if (mode === LOGGER_MODES.File) {
+        // FilePath dateTime
+        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';
+        }
+        // Modify filepath if filepath datetime is true
+        if (filePathDatetime) {
+            filePath = addDatetimeToFileName(filePath);
+        }
+        // Return
+        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),
+            [kJetLogger]: true,
+        };
+    }
+    // Console (Default)
+    return {
+        info: setupPrintToConsole(LEVELS.Info, formatter),
+        imp: setupPrintToConsole(LEVELS.Important, formatter),
+        warn: setupPrintToConsole(LEVELS.Warning, formatter),
+        err: setupPrintToConsole(LEVELS.Error, formatter),
+        [kJetLogger]: true,
+    };
+}
+/**
+ * Print a log with a custom logger function.
+ */
+function setupPrintWithCustomLogger(level, customLogFn) {
+    return (content, printFull) => {
+        let contentNew;
+        if (printFull) {
+            contentNew = util.inspect(content);
+        }
+        else {
+            contentNew = String(content);
+        }
+        return customLogFn(new Date(), level.Prefix, contentNew);
+    };
+}
+/**
+ * Setup line format.
+ */
+function setupLineFormatter(timestamp) {
+    if (timestamp) {
+        return (content, level) => {
+            const contentNew = level.Prefix + ': ' + content, time = '[' + new Date().toISOString() + '] ';
+            return time + contentNew;
+        };
+    }
+    else {
+        return (content, level) => {
+            return level.Prefix + ': ' + content;
+        };
+    }
+}
+/**
+ * Setup json format.
+ */
+function setupJsonFormatter(timestamp) {
+    if (timestamp) {
+        return (content, level) => {
+            const json = {
+                level: level.Prefix,
+                message: content,
+            };
+            json.timestamp = new Date().toISOString();
+            return JSON.stringify(json);
+        };
+    }
+    else {
+        return (content, level) => {
+            const json = {
+                level: level.Prefix,
+                message: content,
+            };
+            return JSON.stringify(json);
+        };
+    }
+}
+/**
+ * Write to file.
+ */
+function setupPrintToFile(level, formatter, filePath) {
+    return (content, printFull) => {
+        let contentNew;
+        if (!!printFull) {
+            contentNew = util.inspect(content);
+        }
+        else {
+            contentNew = String(content);
+        }
+        contentNew = formatter(contentNew, level);
+        fs.appendFile(filePath, contentNew, (err) => {
+            if (!!err) {
+                console.error(err);
+            }
+        });
+    };
+}
+/**
+ * Print a log to the console.
+ */
+function setupPrintToConsole(level, formatter) {
+    return (content, printFull) => {
+        let contentNew;
+        if (!!printFull) {
+            contentNew = util.inspect(content);
+        }
+        else {
+            contentNew = String(content);
+        }
+        const colorFn = colors[level.Color];
+        contentNew = formatter(contentNew, level);
+        console.log(colorFn(contentNew));
+    };
+}
+/**
+ * Prepend the filename in the file path with a timestamp.
+ * i.e. '/home/jet-logger.log' => '/home/20220805T033709_jet-logger.log'
+ */
+function addDatetimeToFileName(filePath) {
+    // Get the date string
+    const dateStr = new Date()
+        .toISOString()
+        .split('-')
+        .join('')
+        .split(':')
+        .join('')
+        .slice(0, 15);
+    // Setup new file name
+    const filePathArr = filePath.split('/'), lastIdx = filePathArr.length - 1, fileName = filePathArr[lastIdx], fileNameNew = dateStr + '_' + fileName;
+    // Setup new file path
+    filePathArr[lastIdx] = fileNameNew;
+    return filePathArr.join('/');
+}
+/**
+ * Check if an object is an instance of jetLogger
+ */
+function instanceOf(arg) {
+    return (typeof arg === 'object' &&
+        arg[kJetLogger] === true);
+}
+/******************************************************************************
+                                  Export
+******************************************************************************/
+export default jetLogger();

package/dist/esm/index.js

@@ -1 +1 @@
-export { LoggerModes, Formats, JetLogger, default as default, } from './JetLogger.js';
+export { JetLogger, jetLogger, default, } from './jetLogger.js';

package/dist/esm/jetLogger.js

@@ -0,0 +1,285 @@
+/* eslint-disable no-console */
+/* eslint-disable no-process-env */
+import colors from 'colors';
+import fs from 'fs';
+import util from 'util';
+/******************************************************************************
+                                 Constants
+******************************************************************************/
+// Options for printing a log.
+const LOGGER_MODES = {
+    Console: 'CONSOLE',
+    File: 'FILE',
+    Custom: 'CUSTOM',
+    Off: 'OFF',
+};
+// Log formats
+const FORMATS = {
+    Line: 'LINE',
+    Json: 'JSON',
+};
+// Note colors here need be a color from
+// the colors library above.
+const LEVELS = {
+    Info: {
+        Color: 'green',
+        Prefix: 'INFO',
+    },
+    Important: {
+        Color: 'magenta',
+        Prefix: 'IMPORTANT',
+    },
+    Warning: {
+        Color: 'yellow',
+        Prefix: 'WARNING',
+    },
+    Error: {
+        Color: 'red',
+        Prefix: 'ERROR',
+    },
+};
+const DEFAULTS = {
+    mode: LOGGER_MODES.Console,
+    filePath: 'jet-logger.log',
+    timestamp: true,
+    format: FORMATS.Line,
+    customLogFn: () => ({}),
+};
+// Errors
+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".',
+};
+export const JetLogger = {
+    Modes: LOGGER_MODES,
+    Formats: FORMATS,
+    instanceOf,
+};
+const kJetLogger = Symbol('k-jet-logger');
+/******************************************************************************
+                               Functions
+******************************************************************************/
+/**
+ * Default function
+ */
+export function jetLogger(options) {
+    let mode = DEFAULTS.mode, filePath = DEFAULTS.filePath, timestamp = DEFAULTS.timestamp, format = DEFAULTS.format, customLogFn = DEFAULTS.customLogFn;
+    // Setup the mode
+    if (options?.mode !== undefined) {
+        mode = options.mode;
+    }
+    else if (!!process.env.JET_LOGGER_MODE) {
+        mode = process.env.JET_LOGGER_MODE.toUpperCase();
+    }
+    // ** Logger Mode Off ** //
+    if (mode === LOGGER_MODES.Off) {
+        return {
+            info: (_, __) => ({}),
+            imp: (_, __) => ({}),
+            warn: (_, __) => ({}),
+            err: (_, __) => ({}),
+            [kJetLogger]: true,
+        };
+    }
+    // ** Custom Logger Function ** //
+    if (mode === LOGGER_MODES.Custom) {
+        if (options?.customLogger !== undefined) {
+            customLogFn = options.customLogger;
+        }
+        if (!customLogFn) {
+            throw Error(Errors.CustomLogger);
+        }
+        return {
+            info: setupPrintWithCustomLogger(LEVELS.Info, customLogFn),
+            imp: setupPrintWithCustomLogger(LEVELS.Important, customLogFn),
+            warn: setupPrintWithCustomLogger(LEVELS.Warning, customLogFn),
+            err: setupPrintWithCustomLogger(LEVELS.Error, customLogFn),
+            [kJetLogger]: true,
+        };
+    }
+    // Filepath
+    if (options?.filepath !== undefined) {
+        filePath = options.filepath;
+    }
+    else if (!!process.env.JET_LOGGER_FILEPATH) {
+        filePath = process.env.JET_LOGGER_FILEPATH;
+    }
+    // Timestamp
+    if (options?.timestamp !== undefined) {
+        timestamp = options.timestamp;
+    }
+    else if (!!process.env.JET_LOGGER_TIMESTAMP) {
+        const envVar = process.env.JET_LOGGER_TIMESTAMP;
+        timestamp = envVar.toUpperCase() === 'TRUE';
+    }
+    // Format
+    if (options?.format !== undefined) {
+        format = options.format;
+    }
+    else if (!!process.env.JET_LOGGER_FORMAT) {
+        format = process.env.JET_LOGGER_FORMAT.toUpperCase();
+    }
+    // Setup the formatter
+    let formatter = () => '';
+    if (format === FORMATS.Line) {
+        formatter = setupLineFormatter(timestamp);
+    }
+    else if (format === FORMATS.Json) {
+        formatter = setupJsonFormatter(timestamp);
+    }
+    // ** Print to File ** //
+    if (mode === LOGGER_MODES.File) {
+        // FilePath dateTime
+        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';
+        }
+        // Modify filepath if filepath datetime is true
+        if (filePathDatetime) {
+            filePath = addDatetimeToFileName(filePath);
+        }
+        // Return
+        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),
+            [kJetLogger]: true,
+        };
+    }
+    // Console (Default)
+    return {
+        info: setupPrintToConsole(LEVELS.Info, formatter),
+        imp: setupPrintToConsole(LEVELS.Important, formatter),
+        warn: setupPrintToConsole(LEVELS.Warning, formatter),
+        err: setupPrintToConsole(LEVELS.Error, formatter),
+        [kJetLogger]: true,
+    };
+}
+/**
+ * Print a log with a custom logger function.
+ */
+function setupPrintWithCustomLogger(level, customLogFn) {
+    return (content, printFull) => {
+        let contentNew;
+        if (printFull) {
+            contentNew = util.inspect(content);
+        }
+        else {
+            contentNew = String(content);
+        }
+        return customLogFn(new Date(), level.Prefix, contentNew);
+    };
+}
+/**
+ * Setup line format.
+ */
+function setupLineFormatter(timestamp) {
+    if (timestamp) {
+        return (content, level) => {
+            const contentNew = level.Prefix + ': ' + content, time = '[' + new Date().toISOString() + '] ';
+            return time + contentNew;
+        };
+    }
+    else {
+        return (content, level) => {
+            return level.Prefix + ': ' + content;
+        };
+    }
+}
+/**
+ * Setup json format.
+ */
+function setupJsonFormatter(timestamp) {
+    if (timestamp) {
+        return (content, level) => {
+            const json = {
+                level: level.Prefix,
+                message: content,
+            };
+            json.timestamp = new Date().toISOString();
+            return JSON.stringify(json);
+        };
+    }
+    else {
+        return (content, level) => {
+            const json = {
+                level: level.Prefix,
+                message: content,
+            };
+            return JSON.stringify(json);
+        };
+    }
+}
+/**
+ * Write to file.
+ */
+function setupPrintToFile(level, formatter, filePath) {
+    return (content, printFull) => {
+        let contentNew;
+        if (!!printFull) {
+            contentNew = util.inspect(content);
+        }
+        else {
+            contentNew = String(content);
+        }
+        contentNew = formatter(contentNew, level);
+        fs.appendFile(filePath, contentNew, (err) => {
+            if (!!err) {
+                console.error(err);
+            }
+        });
+    };
+}
+/**
+ * Print a log to the console.
+ */
+function setupPrintToConsole(level, formatter) {
+    return (content, printFull) => {
+        let contentNew;
+        if (!!printFull) {
+            contentNew = util.inspect(content);
+        }
+        else {
+            contentNew = String(content);
+        }
+        const colorFn = colors[level.Color];
+        contentNew = formatter(contentNew, level);
+        console.log(colorFn(contentNew));
+    };
+}
+/**
+ * Prepend the filename in the file path with a timestamp.
+ * i.e. '/home/jet-logger.log' => '/home/20220805T033709_jet-logger.log'
+ */
+function addDatetimeToFileName(filePath) {
+    // Get the date string
+    const dateStr = new Date()
+        .toISOString()
+        .split('-')
+        .join('')
+        .split(':')
+        .join('')
+        .slice(0, 15);
+    // Setup new file name
+    const filePathArr = filePath.split('/'), lastIdx = filePathArr.length - 1, fileName = filePathArr[lastIdx], fileNameNew = dateStr + '_' + fileName;
+    // Setup new file path
+    filePathArr[lastIdx] = fileNameNew;
+    return filePathArr.join('/');
+}
+/**
+ * Check if an object is an instance of jetLogger
+ */
+function instanceOf(arg) {
+    return (typeof arg === 'object' &&
+        arg[kJetLogger] === true);
+}
+/******************************************************************************
+                                  Export
+******************************************************************************/
+export default jetLogger();

package/dist/types/index.d.ts

@@ -1 +1 @@
-export { LoggerModes, Formats, type TCustomLoggerFunction, JetLogger, default as default, } from './JetLogger.js';
+export { type CustomLogger, JetLogger, jetLogger, default, } from './jetLogger.js';

package/dist/types/jetLogger.d.ts

@@ -0,0 +1,76 @@
+/******************************************************************************
+                                 Constants
+******************************************************************************/
+declare const LOGGER_MODES: {
+    readonly Console: "CONSOLE";
+    readonly File: "FILE";
+    readonly Custom: "CUSTOM";
+    readonly Off: "OFF";
+};
+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 Formats: {
+        readonly Line: "LINE";
+        readonly Json: "JSON";
+    };
+    readonly instanceOf: typeof instanceOf;
+};
+declare const kJetLogger: unique symbol;
+/******************************************************************************
+                                  Types
+******************************************************************************/
+type LoggerModes = (typeof LOGGER_MODES)[keyof typeof LOGGER_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;
+    filepath?: string;
+    filepathDatetimeParam?: boolean;
+    timestamp?: boolean;
+    format?: Formats;
+    customLogger?: CustomLogger;
+}
+interface JetLogger {
+    info: (content: unknown, print?: boolean) => void;
+    imp: (content: unknown, print?: boolean) => void;
+    warn: (content: unknown, print?: boolean) => void;
+    err: (content: unknown, print?: boolean) => void;
+}
+/******************************************************************************
+                               Functions
+******************************************************************************/
+/**
+ * Default function
+ */
+export declare function jetLogger(options?: Options): {
+    readonly info: LogFunction;
+    readonly imp: LogFunction;
+    readonly warn: LogFunction;
+    readonly err: LogFunction;
+    readonly [kJetLogger]: true;
+};
+/**
+ * Check if an object is an instance of jetLogger
+ */
+declare function instanceOf(arg: unknown): arg is JetLogger;
+/******************************************************************************
+                                  Export
+******************************************************************************/
+declare const _default: {
+    readonly info: LogFunction;
+    readonly imp: LogFunction;
+    readonly warn: LogFunction;
+    readonly err: LogFunction;
+    readonly [kJetLogger]: true;
+};
+export default _default;

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "jet-logger",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "A super quick, easy to setup logging tool for NodeJS/TypeScript.",
   "type": "module",
-  "main": "./dist/cjs/index.cjs",
+  "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
   "browser": "./dist/esm/index.js",
   "types": "./dist/types/index.d.ts",
   "exports": {
     ".": {
       "import": "./dist/esm/index.js",
-      "require": "./dist/cjs/index.cjs",
+      "require": "./dist/cjs/index.js",
       "types": "./dist/types/index.d.ts"
     }
   },
@@ -59,11 +59,12 @@
   },
   "homepage": "https://github.com/seanpmaxwell/jet-logger#readme",
   "dependencies": {
-    "colors": "1.3.0"
+    "colors": "1.4.0"
   },
   "devDependencies": {
     "@eslint/js": "^9.26.0",
     "@stylistic/eslint-plugin": "^5.6.1",
+    "@trivago/prettier-plugin-sort-imports": "^6.0.1",
     "@types/node": "^22.8.1",
     "eslint": "^9.26.0",
     "eslint-config-prettier": "^10.1.8",

package/dist/cjs/JetLogger.js

@@ -1,239 +0,0 @@
-/* eslint-disable no-process-env */
-import util from 'util';
-import colors from 'colors';
-import fs from 'fs';
-/******************************************************************************
-                                   Variables
-******************************************************************************/
-// Options for printing a log.
-export const LoggerModes = {
-    Console: 'CONSOLE',
-    File: 'FILE',
-    Custom: 'CUSTOM',
-    Off: 'OFF',
-};
-// Log formats
-export const Formats = {
-    Line: 'LINE',
-    Json: 'JSON',
-};
-// Note colors here need be a color from
-// the colors library above.
-const Levels = {
-    Info: {
-        Color: 'green',
-        Prefix: 'INFO',
-    },
-    Important: {
-        Color: 'magenta',
-        Prefix: 'IMPORTANT',
-    },
-    Warning: {
-        Color: 'yellow',
-        Prefix: 'WARNING',
-    },
-    Error: {
-        Color: 'red',
-        Prefix: 'ERROR',
-    },
-};
-// Errors
-const Errors = {
-    CustomLogFn: '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".',
-};
-/******************************************************************************
-                                Classes
-******************************************************************************/
-export class JetLogger {
-    mode = LoggerModes.Console;
-    filePath = 'jet-logger.log';
-    timestamp = true;
-    format = Formats.Line;
-    customLogFn = () => ({});
-    /**
-     * Constructor
-     */
-    constructor(mode, filepath, filepathDatetimeParam, timestamp, format, customLogFn) {
-        // Setup the mode
-        if (mode !== undefined) {
-            this.mode = mode;
-        }
-        else if (!!process.env.JET_LOGGER_MODE) {
-            this.mode = process.env.JET_LOGGER_MODE.toUpperCase();
-        }
-        // Filepath
-        if (filepath !== undefined) {
-            this.filePath = filepath;
-        }
-        else if (!!process.env.JET_LOGGER_FILEPATH) {
-            this.filePath = process.env.JET_LOGGER_FILEPATH;
-        }
-        // FilePath dateTime
-        let filePathDatetime = true;
-        if (filepathDatetimeParam !== undefined) {
-            filePathDatetime = filepathDatetimeParam;
-        }
-        else if (!!process.env.JET_LOGGER_FILEPATH_DATETIME) {
-            const envVar = process.env.JET_LOGGER_FILEPATH_DATETIME;
-            filePathDatetime = envVar.toUpperCase() === 'TRUE';
-        }
-        // Timestamp
-        if (timestamp !== undefined) {
-            this.timestamp = timestamp;
-        }
-        else if (!!process.env.JET_LOGGER_TIMESTAMP) {
-            const envVar = process.env.JET_LOGGER_TIMESTAMP;
-            this.timestamp = envVar.toUpperCase() === 'TRUE';
-        }
-        // Format
-        if (format !== undefined) {
-            this.format = format;
-        }
-        else if (!!process.env.JET_LOGGER_FORMAT) {
-            this.format = process.env.JET_LOGGER_FORMAT.toUpperCase();
-        }
-        // Modify filepath if filepath datetime is true
-        if (filePathDatetime) {
-            this.filePath = this.addDatetimeToFileName(this.filePath);
-        }
-        // Custom Logger Function
-        if (customLogFn !== undefined) {
-            this.customLogFn = customLogFn;
-        }
-    }
-    /**
-     * Prepend the filename in the file path with a timestamp.
-     * i.e. '/home/jet-logger.log' => '/home/20220805T033709_jet-logger.log'
-     */
-    addDatetimeToFileName(filePath) {
-        // Get the date string
-        const dateStr = new Date()
-            .toISOString()
-            .split('-')
-            .join('')
-            .split(':')
-            .join('')
-            .slice(0, 15);
-        // Setup new file name
-        const filePathArr = filePath.split('/'), lastIdx = filePathArr.length - 1, fileName = filePathArr[lastIdx], fileNameNew = dateStr + '_' + fileName;
-        // Setup new file path
-        filePathArr[lastIdx] = fileNameNew;
-        return filePathArr.join('/');
-    }
-    /**
-     * Print information.
-     */
-    info(content, printFull) {
-        this.printLog(content, !!printFull, Levels.Info);
-    }
-    /**
-     * Print important information.
-     */
-    imp(content, printFull) {
-        this.printLog(content, !!printFull, Levels.Important);
-    }
-    /**
-     * Print important information.
-     */
-    warn(content, printFull) {
-        this.printLog(content, !!printFull, Levels.Warning);
-    }
-    /**
-     * Print important information.
-     */
-    err(content, printFull) {
-        this.printLog(content, !!printFull, Levels.Error);
-    }
-    /**
-     * Print the log using the provided settings.
-     */
-    printLog(contentParam, printFull, level) {
-        // Do nothing if turned off
-        if (this.mode === LoggerModes.Off) {
-            return;
-        }
-        // Print full
-        let content;
-        if (printFull) {
-            content = util.inspect(contentParam);
-        }
-        else {
-            content = String(contentParam);
-        }
-        // Fire the custom logger if that's the option
-        if (this.mode === LoggerModes.Custom) {
-            if (!!this.customLogFn) {
-                return this.customLogFn(new Date(), level.Prefix, content);
-            }
-            else {
-                throw Error(Errors.CustomLogFn);
-            }
-        }
-        // Print line or json
-        if (this.format === Formats.Line) {
-            content = this.setupLineFormat(content, level);
-        }
-        else if (this.format === Formats.Json) {
-            content = this.setupJsonFormat(content, level);
-        }
-        // Print Console
-        if (this.mode === LoggerModes.Console) {
-            const colorFn = colors[level.Color];
-            // eslint-disable-next-line no-console
-            console.log(colorFn(content));
-            // Print File
-        }
-        else if (this.mode === LoggerModes.File) {
-            this.writeToFile(content + '\n');
-            // If reach this point, mode setting was bad
-        }
-        else {
-            throw Error(Errors.Mode);
-        }
-    }
-    /**
-     * Setup line format.
-     */
-    setupLineFormat(content, level) {
-        // Format
-        content = level.Prefix + ': ' + content;
-        if (this.timestamp) {
-            const time = '[' + new Date().toISOString() + '] ';
-            return time + content;
-        }
-        // Return
-        return content;
-    }
-    /**
-     * Setup json format.
-     */
-    setupJsonFormat(content, level) {
-        // Format
-        const json = {
-            level: level.Prefix,
-            message: content,
-        };
-        if (this.timestamp) {
-            json.timestamp = new Date().toISOString();
-        }
-        // Return
-        return JSON.stringify(json);
-    }
-    /**
-     * Write to file.
-     */
-    writeToFile(content) {
-        fs.appendFile(this.filePath, content, (err) => {
-            if (!!err) {
-                // eslint-disable-next-line no-console
-                console.error(err);
-            }
-        });
-    }
-}
-/******************************************************************************
-                                  Export
-******************************************************************************/
-export default new JetLogger();

package/dist/esm/JetLogger.js

@@ -1,239 +0,0 @@
-/* eslint-disable no-process-env */
-import util from 'util';
-import colors from 'colors';
-import fs from 'fs';
-/******************************************************************************
-                                   Variables
-******************************************************************************/
-// Options for printing a log.
-export const LoggerModes = {
-    Console: 'CONSOLE',
-    File: 'FILE',
-    Custom: 'CUSTOM',
-    Off: 'OFF',
-};
-// Log formats
-export const Formats = {
-    Line: 'LINE',
-    Json: 'JSON',
-};
-// Note colors here need be a color from
-// the colors library above.
-const Levels = {
-    Info: {
-        Color: 'green',
-        Prefix: 'INFO',
-    },
-    Important: {
-        Color: 'magenta',
-        Prefix: 'IMPORTANT',
-    },
-    Warning: {
-        Color: 'yellow',
-        Prefix: 'WARNING',
-    },
-    Error: {
-        Color: 'red',
-        Prefix: 'ERROR',
-    },
-};
-// Errors
-const Errors = {
-    CustomLogFn: '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".',
-};
-/******************************************************************************
-                                Classes
-******************************************************************************/
-export class JetLogger {
-    mode = LoggerModes.Console;
-    filePath = 'jet-logger.log';
-    timestamp = true;
-    format = Formats.Line;
-    customLogFn = () => ({});
-    /**
-     * Constructor
-     */
-    constructor(mode, filepath, filepathDatetimeParam, timestamp, format, customLogFn) {
-        // Setup the mode
-        if (mode !== undefined) {
-            this.mode = mode;
-        }
-        else if (!!process.env.JET_LOGGER_MODE) {
-            this.mode = process.env.JET_LOGGER_MODE.toUpperCase();
-        }
-        // Filepath
-        if (filepath !== undefined) {
-            this.filePath = filepath;
-        }
-        else if (!!process.env.JET_LOGGER_FILEPATH) {
-            this.filePath = process.env.JET_LOGGER_FILEPATH;
-        }
-        // FilePath dateTime
-        let filePathDatetime = true;
-        if (filepathDatetimeParam !== undefined) {
-            filePathDatetime = filepathDatetimeParam;
-        }
-        else if (!!process.env.JET_LOGGER_FILEPATH_DATETIME) {
-            const envVar = process.env.JET_LOGGER_FILEPATH_DATETIME;
-            filePathDatetime = envVar.toUpperCase() === 'TRUE';
-        }
-        // Timestamp
-        if (timestamp !== undefined) {
-            this.timestamp = timestamp;
-        }
-        else if (!!process.env.JET_LOGGER_TIMESTAMP) {
-            const envVar = process.env.JET_LOGGER_TIMESTAMP;
-            this.timestamp = envVar.toUpperCase() === 'TRUE';
-        }
-        // Format
-        if (format !== undefined) {
-            this.format = format;
-        }
-        else if (!!process.env.JET_LOGGER_FORMAT) {
-            this.format = process.env.JET_LOGGER_FORMAT.toUpperCase();
-        }
-        // Modify filepath if filepath datetime is true
-        if (filePathDatetime) {
-            this.filePath = this.addDatetimeToFileName(this.filePath);
-        }
-        // Custom Logger Function
-        if (customLogFn !== undefined) {
-            this.customLogFn = customLogFn;
-        }
-    }
-    /**
-     * Prepend the filename in the file path with a timestamp.
-     * i.e. '/home/jet-logger.log' => '/home/20220805T033709_jet-logger.log'
-     */
-    addDatetimeToFileName(filePath) {
-        // Get the date string
-        const dateStr = new Date()
-            .toISOString()
-            .split('-')
-            .join('')
-            .split(':')
-            .join('')
-            .slice(0, 15);
-        // Setup new file name
-        const filePathArr = filePath.split('/'), lastIdx = filePathArr.length - 1, fileName = filePathArr[lastIdx], fileNameNew = dateStr + '_' + fileName;
-        // Setup new file path
-        filePathArr[lastIdx] = fileNameNew;
-        return filePathArr.join('/');
-    }
-    /**
-     * Print information.
-     */
-    info(content, printFull) {
-        this.printLog(content, !!printFull, Levels.Info);
-    }
-    /**
-     * Print important information.
-     */
-    imp(content, printFull) {
-        this.printLog(content, !!printFull, Levels.Important);
-    }
-    /**
-     * Print important information.
-     */
-    warn(content, printFull) {
-        this.printLog(content, !!printFull, Levels.Warning);
-    }
-    /**
-     * Print important information.
-     */
-    err(content, printFull) {
-        this.printLog(content, !!printFull, Levels.Error);
-    }
-    /**
-     * Print the log using the provided settings.
-     */
-    printLog(contentParam, printFull, level) {
-        // Do nothing if turned off
-        if (this.mode === LoggerModes.Off) {
-            return;
-        }
-        // Print full
-        let content;
-        if (printFull) {
-            content = util.inspect(contentParam);
-        }
-        else {
-            content = String(contentParam);
-        }
-        // Fire the custom logger if that's the option
-        if (this.mode === LoggerModes.Custom) {
-            if (!!this.customLogFn) {
-                return this.customLogFn(new Date(), level.Prefix, content);
-            }
-            else {
-                throw Error(Errors.CustomLogFn);
-            }
-        }
-        // Print line or json
-        if (this.format === Formats.Line) {
-            content = this.setupLineFormat(content, level);
-        }
-        else if (this.format === Formats.Json) {
-            content = this.setupJsonFormat(content, level);
-        }
-        // Print Console
-        if (this.mode === LoggerModes.Console) {
-            const colorFn = colors[level.Color];
-            // eslint-disable-next-line no-console
-            console.log(colorFn(content));
-            // Print File
-        }
-        else if (this.mode === LoggerModes.File) {
-            this.writeToFile(content + '\n');
-            // If reach this point, mode setting was bad
-        }
-        else {
-            throw Error(Errors.Mode);
-        }
-    }
-    /**
-     * Setup line format.
-     */
-    setupLineFormat(content, level) {
-        // Format
-        content = level.Prefix + ': ' + content;
-        if (this.timestamp) {
-            const time = '[' + new Date().toISOString() + '] ';
-            return time + content;
-        }
-        // Return
-        return content;
-    }
-    /**
-     * Setup json format.
-     */
-    setupJsonFormat(content, level) {
-        // Format
-        const json = {
-            level: level.Prefix,
-            message: content,
-        };
-        if (this.timestamp) {
-            json.timestamp = new Date().toISOString();
-        }
-        // Return
-        return JSON.stringify(json);
-    }
-    /**
-     * Write to file.
-     */
-    writeToFile(content) {
-        fs.appendFile(this.filePath, content, (err) => {
-            if (!!err) {
-                // eslint-disable-next-line no-console
-                console.error(err);
-            }
-        });
-    }
-}
-/******************************************************************************
-                                  Export
-******************************************************************************/
-export default new JetLogger();

package/dist/types/JetLogger.d.ts

@@ -1,75 +0,0 @@
-/******************************************************************************
-                                   Variables
-******************************************************************************/
-export declare const LoggerModes: {
-    readonly Console: "CONSOLE";
-    readonly File: "FILE";
-    readonly Custom: "CUSTOM";
-    readonly Off: "OFF";
-};
-export declare const Formats: {
-    readonly Line: "LINE";
-    readonly Json: "JSON";
-};
-/******************************************************************************
-                                  Types
-******************************************************************************/
-type TLoggerModes = (typeof LoggerModes)[keyof typeof LoggerModes];
-type TFormats = (typeof Formats)[keyof typeof Formats];
-export type TCustomLoggerFunction = (timestamp: Date, prefix: string, content: unknown) => void;
-/******************************************************************************
-                                Classes
-******************************************************************************/
-export declare class JetLogger {
-    private mode;
-    private filePath;
-    private timestamp;
-    private format;
-    private customLogFn;
-    /**
-     * Constructor
-     */
-    constructor(mode?: TLoggerModes, filepath?: string, filepathDatetimeParam?: boolean, timestamp?: boolean, format?: TFormats, customLogFn?: TCustomLoggerFunction);
-    /**
-     * Prepend the filename in the file path with a timestamp.
-     * i.e. '/home/jet-logger.log' => '/home/20220805T033709_jet-logger.log'
-     */
-    private addDatetimeToFileName;
-    /**
-     * Print information.
-     */
-    info(content: unknown, printFull?: boolean): void;
-    /**
-     * Print important information.
-     */
-    imp(content: unknown, printFull?: boolean): void;
-    /**
-     * Print important information.
-     */
-    warn(content: unknown, printFull?: boolean): void;
-    /**
-     * Print important information.
-     */
-    err(content: unknown, printFull?: boolean): void;
-    /**
-     * Print the log using the provided settings.
-     */
-    private printLog;
-    /**
-     * Setup line format.
-     */
-    private setupLineFormat;
-    /**
-     * Setup json format.
-     */
-    private setupJsonFormat;
-    /**
-     * Write to file.
-     */
-    private writeToFile;
-}
-/******************************************************************************
-                                  Export
-******************************************************************************/
-declare const _default: JetLogger;
-export default _default;