jet-logger 1.2.1 → 1.2.4

package/README.md

@@ -4,9 +4,7 @@
 
 
 ## What is it
-Jet-Logger is an easy to configure logging tool that allows you change settings via the environment
-variables (recommended) or manually in code. You can easily switch your logs to be printed out to the command line, a file, sent through your own custom logging logic, or turned off completely. Logs printed to the console also are printed out in different colors depending on whether they're info, a warning, an error, etc. The file for holding logs can be specified manually or left as the default. You can also have
-logs formatted as lines for easy reading or as JSON objects.
+Jet-Logger is an easy to configure logging tool that allows you change settings via the environment variables (recommended) or manually in code. You can easily switch your logs to be printed out to the command line, a file, sent through your own custom logging logic, or turned off completely. Logs printed to the console also are printed out in different colors depending on whether they're info, a warning, an error, etc. The file for holding logs can be specified manually or left as the default. You can also have logs formatted as lines for easy reading or as JSON objects.
 <br/>
 
 ### Installation
@@ -17,14 +15,14 @@ $ npm install --save jet-logger
 ### Guide
 The logger package's main export is the `logger` object. Logger can used statically or as an instance 
 object with settings configured through a constructor. Variables passed through the constructor will
-take priority over environment variables. Note that file writes happen asynchronously. 
+take priority over environment variables. Note that file writes happen asynchronously.
 
 - 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_DATETIME`: prepend the log file name with the datetime. Can 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'`.
+  - `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_DATETIME`: prepend the log file name with the datetime. Can 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'`.
 
 _logger_ has an export `LoggerModes` which is an enum that provides all the modes if you want to
 use them in code. I would recommend using `Console` for local development, `File` for remote development, 
@@ -32,17 +30,18 @@ and `Custom` or `Off` for production. If you want to change the settings in code
 <br>
 
 - There are 4 functions on Logger to print logs.
-    - `info`: prints green.
-    - `imp`: prints magenta. 
-    - `warn`: prints yellow.
-    - `err`: prints red.
+  - `info`: prints green.
+  - `imp`: prints magenta. 
+  - `warn`: prints yellow.
+  - `err`: prints red.
 
 There is an optional second param to each method which is a `boolean`. If you pass `true` as the second 
 param, JetLogger will use node's `util` so that the full object gets printed. You should NOT normally 
 use this param, but it is especially useful when debugging errors so that you can print out the full 
 error object and observe the stack trace.<br>
 
-Let's look at some sample code in an express route:
+Let's look at some sample code in an express route. Here's a link to a sample-project which displays similiar to what's below (https://github.com/seanpmaxwell/jet-logger-sample).
+
 
 ````typescript
 /* Some script that is run before the route script */
@@ -64,15 +63,15 @@ const router = Router();
 
 
 router.get('api/users/alt', async (req: Request, res: Reponse) => {
-    logger.info(req.params.msg);
-    logger.imp(req.params.msg);
-    logger.warn(req.params.msg);
-    logger.err(req.params.msg);
-    logger.err(new Error('printing out an error'));
-    logger.err(new Error('printing out an error full'), true);  // <-- print the full Error object
-    return res.status(OK).json({
-        message: 'console_mode',
-    });
+  logger.info(req.params.msg);
+  logger.imp(req.params.msg);
+  logger.warn(req.params.msg);
+  logger.err(req.params.msg);
+  logger.err(new Error('printing out an error'));
+  logger.err(new Error('printing out an error full'), true);  // <-- print the full Error object
+  return res.status(OK).json({
+    message: 'console_mode',
+  });
 });
 ````
 
@@ -111,15 +110,15 @@ import { thirdPartyLoggingApp } from 'thirdPartyLoggingApplicationLib';
 
 // Needs to be implemented
 const customSend: TCustomLogger = (timestamp: Date, level: string, content: any) => {
-    thirdPartyLoggingApp.doStuff(...);
+  thirdPartyLoggingApp.doStuff(...);
 }
 
 router.get('api/users', async (req: Request, res: Reponse) => {
-    const logger = JetLogger(LoggerModes.CUSTOM, '', true, true, undefined, customSend);
-    logger.rmTimestamp = true;
-    logger.info(req.params.msg);
-    return res.status(OK).json({
-        message: 'console_mode',
-    });
+  const logger = JetLogger(LoggerModes.CUSTOM, '', true, true, undefined, customSend);
+  logger.rmTimestamp = true;
+  logger.info(req.params.msg);
+  return res.status(OK).json({
+    message: 'console_mode',
+  });
 });
 ````

package/lib/JetLogger.d.ts

@@ -0,0 +1,31 @@
+export declare enum LoggerModes {
+    Console = "CONSOLE",
+    File = "FILE",
+    Custom = "CUSTOM",
+    Off = "OFF"
+}
+export declare enum Formats {
+    Line = "LINE",
+    Json = "JSON"
+}
+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 filepathDatetime: boolean;
+        readonly timestamp: boolean;
+        readonly format: Formats;
+        readonly customLogger: TCustomLogger | undefined;
+    };
+    readonly info: typeof info;
+    readonly imp: typeof imp;
+    readonly warn: typeof warn;
+    readonly err: typeof err;
+};
+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;
+export {};

package/lib/JetLogger.js

@@ -0,0 +1,188 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JetLogger = exports.Formats = exports.LoggerModes = void 0;
+var util_1 = __importDefault(require("util"));
+var colors_1 = __importDefault(require("colors"));
+var fs_1 = __importDefault(require("fs"));
+var LoggerModes;
+(function (LoggerModes) {
+    LoggerModes["Console"] = "CONSOLE";
+    LoggerModes["File"] = "FILE";
+    LoggerModes["Custom"] = "CUSTOM";
+    LoggerModes["Off"] = "OFF";
+})(LoggerModes = exports.LoggerModes || (exports.LoggerModes = {}));
+var Formats;
+(function (Formats) {
+    Formats["Line"] = "LINE";
+    Formats["Json"] = "JSON";
+})(Formats = exports.Formats || (exports.Formats = {}));
+var levels = {
+    info: {
+        color: 'green',
+        prefix: 'INFO',
+    },
+    imp: {
+        color: 'magenta',
+        prefix: 'IMPORTANT',
+    },
+    warn: {
+        color: 'yellow',
+        prefix: 'WARNING',
+    },
+    err: {
+        color: 'red',
+        prefix: 'ERROR',
+    }
+};
+var errors = {
+    customLoggerErr: 'Custom logger mode set to true, but no custom logger was provided.',
+    modeErr: 'The correct logger mode was not specified: Must be "CUSTOM", "FILE", ' +
+        '"OFF", or "CONSOLE".'
+};
+var defaults = {
+    filepath: 'jet-logger.log',
+    mode: LoggerModes.Console,
+    timestamp: true,
+    filepathDatetime: true,
+    format: Formats.Line,
+};
+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, filepathDatetime, timestamp, format, customLogger) {
+    if (!mode) {
+        if (!!process.env.JET_LOGGER_MODE) {
+            mode = process.env.JET_LOGGER_MODE.toUpperCase();
+        }
+        else {
+            mode = defaults.mode;
+        }
+    }
+    if (!filepath) {
+        if (!!process.env.JET_LOGGER_FILEPATH) {
+            filepath = process.env.JET_LOGGER_FILEPATH;
+        }
+        else {
+            filepath = defaults.filepath;
+        }
+    }
+    if (filepathDatetime === undefined || filepathDatetime === null) {
+        var envVar = process.env.JET_LOGGER_FILEPATH_DATETIME;
+        if (!!envVar) {
+            filepathDatetime = (envVar.toUpperCase() === 'TRUE');
+        }
+        else {
+            filepathDatetime = defaults.filepathDatetime;
+        }
+    }
+    if (timestamp === undefined || timestamp === null) {
+        if (!!process.env.JET_LOGGER_TIMESTAMP) {
+            timestamp = (process.env.JET_LOGGER_TIMESTAMP.toUpperCase() === 'TRUE');
+        }
+        else {
+            timestamp = defaults.timestamp;
+        }
+    }
+    if (!format) {
+        if (!!process.env.JET_LOGGER_FORMAT) {
+            format = process.env.JET_LOGGER_FORMAT.toUpperCase();
+        }
+        else {
+            format = defaults.format;
+        }
+    }
+    if (filepathDatetime) {
+        filepath = addDatetimeToFileName(filepath);
+    }
+    return {
+        mode: mode,
+        filepath: filepath,
+        filepathDatetime: filepathDatetime,
+        timestamp: timestamp,
+        format: format,
+        customLogger: customLogger,
+    };
+}
+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], fileNameNew = (dateStr + '_' + fileName);
+    filePathArr[lastIdx] = fileNameNew;
+    return filePathArr.join('/');
+}
+function info(content, printFull) {
+    return printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, levels.info, this.settings);
+}
+function imp(content, printFull) {
+    return printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, levels.imp, this.settings);
+}
+function warn(content, printFull) {
+    return printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, levels.warn, this.settings);
+}
+function err(content, printFull) {
+    return printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, levels.err, this.settings);
+}
+function printLog(content, printFull, level, settings) {
+    var mode = settings.mode, format = settings.format, timestamp = settings.timestamp, filepath = settings.filepath, customLogger = settings.customLogger;
+    if (mode === LoggerModes.Off) {
+        return;
+    }
+    else if (mode === LoggerModes.Custom) {
+        if (!!customLogger) {
+            return customLogger(new Date(), level.prefix, content);
+        }
+        else {
+            throw Error(errors.customLoggerErr);
+        }
+    }
+    if (printFull) {
+        content = util_1.default.inspect(content);
+    }
+    if (format === Formats.Line) {
+        content = setupLineFormat(content, timestamp, level);
+    }
+    else if (format === Formats.Json) {
+        content = setupJsonFormat(content, timestamp, level);
+    }
+    if (mode === LoggerModes.Console) {
+        var colorFn = colors_1.default[level.color];
+        console.log(colorFn(content));
+    }
+    else if (mode === LoggerModes.File) {
+        writeToFile(content + '\n', filepath)
+            .catch(function (err) { return console.log(err); });
+    }
+    else {
+        throw Error(errors.modeErr);
+    }
+}
+function setupLineFormat(content, timestamp, level) {
+    content = (level.prefix + ': ' + content);
+    if (timestamp) {
+        var time = '[' + new Date().toISOString() + '] ';
+        return (time + content);
+    }
+    return content;
+}
+function setupJsonFormat(content, timestamp, level) {
+    var json = {
+        level: level.prefix,
+        message: content,
+    };
+    if (timestamp) {
+        json.timestamp = new Date().toISOString();
+    }
+    return JSON.stringify(json);
+}
+function writeToFile(content, filePath) {
+    return new Promise(function (res, rej) {
+        return fs_1.default.appendFile(filePath, content, (function (err) { return !!err ? rej(err) : res(); }));
+    });
+}

package/lib/index.d.ts

@@ -1,45 +1,16 @@
-export declare enum LoggerModes {
-    Console = "CONSOLE",
-    File = "FILE",
-    Custom = "CUSTOM",
-    Off = "OFF"
-}
-export declare enum Formats {
-    Line = "LINE",
-    Json = "JSON"
-}
-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 filepathDatetime: boolean;
-        readonly timestamp: boolean;
-        readonly format: Formats;
-        readonly customLogger: TCustomLogger | undefined;
-    };
-    readonly info: typeof info;
-    readonly imp: typeof imp;
-    readonly warn: typeof warn;
-    readonly err: typeof err;
-};
-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;
+export { LoggerModes, Formats, TCustomLogger, JetLogger, } from './JetLogger';
 declare const _default: {
     readonly settings: {
-        readonly mode: LoggerModes;
+        readonly mode: import("./JetLogger").LoggerModes;
         readonly filepath: string;
         readonly filepathDatetime: boolean;
         readonly timestamp: boolean;
-        readonly format: Formats;
-        readonly customLogger: TCustomLogger | undefined;
+        readonly format: import("./JetLogger").Formats;
+        readonly customLogger: import("./JetLogger").TCustomLogger | undefined;
     };
-    readonly info: typeof info;
-    readonly imp: typeof imp;
-    readonly warn: typeof warn;
-    readonly err: typeof err;
+    readonly info: (this: any, content: any, printFull?: boolean | undefined) => void;
+    readonly imp: (this: any, content: any, printFull?: boolean | undefined) => void;
+    readonly warn: (this: any, content: any, printFull?: boolean | undefined) => void;
+    readonly err: (this: any, content: any, printFull?: boolean | undefined) => void;
 };
 export default _default;

package/lib/index.js

@@ -1,192 +1,9 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.JetLogger = exports.Formats = exports.LoggerModes = void 0;
-var util_1 = __importDefault(require("util"));
-var colors_1 = __importDefault(require("colors"));
-var fs_1 = __importDefault(require("fs"));
-var LoggerModes;
-(function (LoggerModes) {
-    LoggerModes["Console"] = "CONSOLE";
-    LoggerModes["File"] = "FILE";
-    LoggerModes["Custom"] = "CUSTOM";
-    LoggerModes["Off"] = "OFF";
-})(LoggerModes = exports.LoggerModes || (exports.LoggerModes = {}));
-var Formats;
-(function (Formats) {
-    Formats["Line"] = "LINE";
-    Formats["Json"] = "JSON";
-})(Formats = exports.Formats || (exports.Formats = {}));
-var levels = {
-    info: {
-        color: 'green',
-        prefix: 'INFO',
-    },
-    imp: {
-        color: 'magenta',
-        prefix: 'IMPORTANT',
-    },
-    warn: {
-        color: 'yellow',
-        prefix: 'WARNING',
-    },
-    err: {
-        color: 'red',
-        prefix: 'ERROR',
-    }
-};
-var errors = {
-    customLoggerErr: 'Custom logger mode set to true, but no custom logger was provided.',
-    modeErr: 'The correct logger mode was not specified: Must be "CUSTOM", "FILE", ' +
-        '"OFF", or "CONSOLE".'
-};
-var defaults = {
-    filepath: 'jet-logger.log',
-    mode: LoggerModes.Console,
-    timestamp: true,
-    filepathDatetime: true,
-    format: Formats.Line,
-};
-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, filepathDatetime, timestamp, format, customLogger) {
-    if (!mode) {
-        if (!!process.env.JET_LOGGER_MODE) {
-            mode = process.env.JET_LOGGER_MODE.toUpperCase();
-        }
-        else {
-            mode = defaults.mode;
-        }
-    }
-    if (!filepath) {
-        if (!!process.env.JET_LOGGER_FILEPATH) {
-            filepath = process.env.JET_LOGGER_FILEPATH;
-        }
-        else {
-            filepath = defaults.filepath;
-        }
-    }
-    if (filepathDatetime === undefined || filepathDatetime === null) {
-        var envVar = process.env.JET_LOGGER_FILEPATH_DATETIME;
-        if (!!envVar) {
-            filepathDatetime = (envVar.toUpperCase() === 'TRUE');
-        }
-        else {
-            filepathDatetime = defaults.filepathDatetime;
-        }
-    }
-    if (timestamp === undefined || timestamp === null) {
-        if (!!process.env.JET_LOGGER_TIMESTAMP) {
-            timestamp = (process.env.JET_LOGGER_TIMESTAMP.toUpperCase() === 'TRUE');
-        }
-        else {
-            timestamp = defaults.timestamp;
-        }
-    }
-    if (!format) {
-        if (!!process.env.JET_LOGGER_FORMAT) {
-            format = process.env.JET_LOGGER_FORMAT.toUpperCase();
-        }
-        else {
-            format = defaults.format;
-        }
-    }
-    return {
-        mode: mode,
-        filepath: filepath,
-        filepathDatetime: filepathDatetime,
-        timestamp: timestamp,
-        format: format,
-        customLogger: customLogger,
-    };
-}
-function info(content, printFull) {
-    return printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, levels.info, this.settings);
-}
-function imp(content, printFull) {
-    return printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, levels.imp, this.settings);
-}
-function warn(content, printFull) {
-    return printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, levels.warn, this.settings);
-}
-function err(content, printFull) {
-    return printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, levels.err, this.settings);
-}
-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;
-    }
-    var jsonContent = {};
-    if (printFull) {
-        content = util_1.default.inspect(content);
-    }
-    if (format === Formats.Json) {
-        jsonContent.message = content;
-    }
-    if (mode !== LoggerModes.Custom) {
-        if (format === Formats.Line) {
-            content = level.prefix + ': ' + content;
-        }
-        else if (format === Formats.Json) {
-            jsonContent.level = level.prefix;
-        }
-    }
-    if (timestamp) {
-        if (format === Formats.Line) {
-            var time = '[' + new Date().toISOString() + '] ';
-            content = time + content;
-        }
-        else if (format === Formats.Json) {
-            jsonContent.timestamp = new Date().toISOString();
-        }
-    }
-    if (format === Formats.Json) {
-        content = JSON.stringify(jsonContent);
-    }
-    if (mode === LoggerModes.Console) {
-        var colorFn = colors_1.default[level.color];
-        console.log(colorFn(content));
-    }
-    else if (mode === LoggerModes.File) {
-        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) {
-            customLogger(new Date(), level.prefix, content);
-        }
-        else {
-            throw Error(errors.customLoggerErr);
-        }
-    }
-    else {
-        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], 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) {
-            return (!!err ? rej(err) : res());
-        });
-    });
-}
-exports.default = JetLogger();
+var JetLogger_1 = require("./JetLogger");
+var JetLogger_2 = require("./JetLogger");
+Object.defineProperty(exports, "LoggerModes", { enumerable: true, get: function () { return JetLogger_2.LoggerModes; } });
+Object.defineProperty(exports, "Formats", { enumerable: true, get: function () { return JetLogger_2.Formats; } });
+Object.defineProperty(exports, "JetLogger", { enumerable: true, get: function () { return JetLogger_2.JetLogger; } });
+exports.default = (0, JetLogger_1.JetLogger)();

package/package.json

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