jet-logger 1.2.6 → 1.3.0

package/README.md

@@ -4,7 +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, written in 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
@@ -13,20 +13,16 @@ $ 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.
+The logger package's main export is the default `logger` object. This default export will use of course, all the default settings. If you wish to pass your own settings you can import the `jetLogger()` function and pass parameters to configure your own custom logging objects.
 
-- The four environment variables are:
+- The five 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'`.
 
-_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, 
-and `Custom` or `Off` for production. If you want to change the settings in code, you can do so via importing the `JetLogger` function and calling it with whatever options you want.
+_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, and `Custom` or `Off` for production. If you want to change the settings in code, you can do so via importing the `JetLogger` function and calling it with whatever options you want.
 <br>
 
 - There are 4 functions on Logger to print logs.
@@ -35,12 +31,9 @@ and `Custom` or `Off` for production. If you want to change the settings in code
   - `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>
+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. Here's a link to a sample-project which displays similar to what's below (https://github.com/seanpmaxwell/jet-logger-sample).
+Let's look at some sample code in an express route.
 
 
 ````typescript
@@ -59,8 +52,8 @@ import { OK } from 'http-status-codes';
 import { Router, Request, Response } from 'express';
 import logger from 'jet-logger';
 
-const router = Router();
 
+const router = Router();
 
 router.get('api/users/alt', async (req: Request, res: Reponse) => {
   logger.info(req.params.msg);
@@ -97,24 +90,24 @@ router.get('api/users/alt', async (req: Request, res: Reponse) => {
 
 
 ### Using a custom logger 
-For production you'll probably have some third party logging tool like ElasticSearch or Splunk. _logger_ exports a type `TCustomLogger` that needs to implemented. If you implement this function and pass it to JetLogger and set the mode to `CUSTOM`, Logger will call whatever logic you created for `sendLog()`.
+For production you'll probably have some third party logging tool like ElasticSearch or Splunk. _logger_ exports a type `TCustomLogFn` that needs to implemented. If you implement this function and pass it to JetLogger and set the mode to `CUSTOM`, Logger will call whatever logic you created for it.
 
 
 ````typescript
 // In the route file
 import { OK } from 'http-status-codes';
 import { Router, Request, Response } from 'express';
-import { JetLogger, ICustomLogger } from 'jet-logger';
+import { jetLogger, TCustomLogFn, ILogger } from 'jet-logger';
 import { thirdPartyLoggingApp } from 'thirdPartyLoggingApplicationLib';
 
 
 // Needs to be implemented
-const customSend: TCustomLogger = (timestamp: Date, level: string, content: any) => {
+const customSend: TCustomLogFn = (timestamp: Date, level: string, content: any) => {
   thirdPartyLoggingApp.doStuff(...);
 }
 
 router.get('api/users', async (req: Request, res: Reponse) => {
-  const logger = JetLogger(LoggerModes.CUSTOM, '', true, true, undefined, customSend);
+  const logger: ILogger = 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

@@ -1,16 +1 @@
-export { LoggerModes, Formats, TCustomLogger, JetLogger, } from './JetLogger';
-declare const _default: {
-    readonly settings: {
-        readonly mode: import("./JetLogger").LoggerModes;
-        readonly filepath: string;
-        readonly filepathDatetime: boolean;
-        readonly timestamp: boolean;
-        readonly format: import("./JetLogger").Formats;
-        readonly customLogger: import("./JetLogger").TCustomLogger | undefined;
-    };
-    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;
+export { LoggerModes, Formats, TCustomLogFn, ILogger, jetLogger, default as default, } from './jetLogger';

package/lib/index.js

@@ -1,9 +1,11 @@
 "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 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)();
+exports.default = exports.jetLogger = exports.Formats = exports.LoggerModes = void 0;
+var jetLogger_1 = require("./jetLogger");
+Object.defineProperty(exports, "LoggerModes", { enumerable: true, get: function () { return jetLogger_1.LoggerModes; } });
+Object.defineProperty(exports, "Formats", { enumerable: true, get: function () { return jetLogger_1.Formats; } });
+Object.defineProperty(exports, "jetLogger", { enumerable: true, get: function () { return jetLogger_1.jetLogger; } });
+Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(jetLogger_1).default; } });

package/lib/jetLogger.d.ts

@@ -0,0 +1,30 @@
+export declare enum LoggerModes {
+    Console = "CONSOLE",
+    File = "FILE",
+    Custom = "CUSTOM",
+    Off = "OFF"
+}
+export declare enum Formats {
+    Line = "LINE",
+    Json = "JSON"
+}
+declare type TLogFn = (content: any, printFull?: boolean) => void;
+export declare type TCustomLogFn = (timestamp: Date, prefix: string, content: unknown) => void;
+export interface ILogger {
+    settings: ISettings;
+    info: TLogFn;
+    imp: TLogFn;
+    warn: TLogFn;
+    err: TLogFn;
+}
+interface ISettings {
+    mode: LoggerModes;
+    filepath: string;
+    filepathDatetime: boolean;
+    timestamp: boolean;
+    format: Formats;
+    customLogFn?: TCustomLogFn;
+}
+export declare function jetLogger(mode?: LoggerModes, filepath?: string, filepathDatetime?: boolean, timestamp?: boolean, format?: Formats, customLogFn?: TCustomLogFn): ILogger;
+declare const _default: ILogger;
+export default _default;

package/lib/{JetLogger.js → jetLogger.js}

@@ -3,7 +3,7 @@ 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;
+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"));
@@ -19,48 +19,49 @@ var Formats;
     Formats["Line"] = "LINE";
     Formats["Json"] = "JSON";
 })(Formats = exports.Formats || (exports.Formats = {}));
-var levels = {
-    info: {
-        color: 'green',
-        prefix: 'INFO',
+var Levels = {
+    Info: {
+        Color: 'green',
+        Prefix: 'INFO',
     },
-    imp: {
-        color: 'magenta',
-        prefix: 'IMPORTANT',
+    Imp: {
+        Color: 'magenta',
+        Prefix: 'IMPORTANT',
     },
-    warn: {
-        color: 'yellow',
-        prefix: 'WARNING',
+    Warn: {
+        Color: 'yellow',
+        Prefix: 'WARNING',
     },
-    err: {
-        color: 'red',
-        prefix: 'ERROR',
+    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 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".'
 };
-var defaults = {
-    filepath: 'jet-logger.log',
-    mode: LoggerModes.Console,
-    timestamp: true,
-    filepathDatetime: true,
-    format: Formats.Line,
+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);
+function jetLogger(mode, filepath, filepathDatetime, timestamp, format, customLogFn) {
+    var settings = getSettings(mode, filepath, timestamp, filepathDatetime, format, customLogFn);
     return { settings: settings, info: info, imp: imp, warn: warn, err: err };
 }
-exports.JetLogger = JetLogger;
-function getSettings(mode, filepath, filepathDatetime, timestamp, format, customLogger) {
+exports.jetLogger = jetLogger;
+function getSettings(mode, filepath, filepathDatetime, timestamp, format, customLogFn) {
     if (!mode) {
         if (!!process.env.JET_LOGGER_MODE) {
             mode = process.env.JET_LOGGER_MODE.toUpperCase();
         }
         else {
-            mode = defaults.mode;
+            mode = Defaults.Mode;
         }
     }
     if (!filepath) {
@@ -68,7 +69,7 @@ function getSettings(mode, filepath, filepathDatetime, timestamp, format, custom
             filepath = process.env.JET_LOGGER_FILEPATH;
         }
         else {
-            filepath = defaults.filepath;
+            filepath = Defaults.Filepath;
         }
     }
     if (filepathDatetime === undefined || filepathDatetime === null) {
@@ -77,7 +78,7 @@ function getSettings(mode, filepath, filepathDatetime, timestamp, format, custom
             filepathDatetime = (envVar.toUpperCase() === 'TRUE');
         }
         else {
-            filepathDatetime = defaults.filepathDatetime;
+            filepathDatetime = Defaults.FilepathDatetime;
         }
     }
     if (timestamp === undefined || timestamp === null) {
@@ -85,7 +86,7 @@ function getSettings(mode, filepath, filepathDatetime, timestamp, format, custom
             timestamp = (process.env.JET_LOGGER_TIMESTAMP.toUpperCase() === 'TRUE');
         }
         else {
-            timestamp = defaults.timestamp;
+            timestamp = Defaults.Timestamp;
         }
     }
     if (!format) {
@@ -93,7 +94,7 @@ function getSettings(mode, filepath, filepathDatetime, timestamp, format, custom
             format = process.env.JET_LOGGER_FORMAT.toUpperCase();
         }
         else {
-            format = defaults.format;
+            format = Defaults.Format;
         }
     }
     if (filepathDatetime) {
@@ -105,7 +106,7 @@ function getSettings(mode, filepath, filepathDatetime, timestamp, format, custom
         filepathDatetime: filepathDatetime,
         timestamp: timestamp,
         format: format,
-        customLogger: customLogger,
+        customLogFn: customLogFn,
     };
 }
 function addDatetimeToFileName(filePath) {
@@ -118,19 +119,19 @@ function addDatetimeToFileName(filePath) {
     return filePathArr.join('/');
 }
 function info(content, printFull) {
-    return printLog(content, printFull !== null && printFull !== void 0 ? printFull : false, levels.info, this.settings);
+    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);
+    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);
+    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);
+    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;
+    var mode = settings.mode, format = settings.format, timestamp = settings.timestamp, filepath = settings.filepath, customLogFn = settings.customLogFn;
     if (mode === LoggerModes.Off) {
         return;
     }
@@ -138,11 +139,11 @@ function printLog(content, printFull, level, settings) {
         content = util_1.default.inspect(content);
     }
     if (mode === LoggerModes.Custom) {
-        if (!!customLogger) {
-            return customLogger(new Date(), level.prefix, content);
+        if (!!customLogFn) {
+            return customLogFn(new Date(), level.Prefix, content);
         }
         else {
-            throw Error(errors.customLoggerErr);
+            throw Error(Errors.customLogFn);
         }
     }
     if (format === Formats.Line) {
@@ -152,7 +153,7 @@ function printLog(content, printFull, level, settings) {
         content = setupJsonFormat(content, timestamp, level);
     }
     if (mode === LoggerModes.Console) {
-        var colorFn = colors_1.default[level.color];
+        var colorFn = colors_1.default[level.Color];
         console.log(colorFn(content));
     }
     else if (mode === LoggerModes.File) {
@@ -160,11 +161,11 @@ function printLog(content, printFull, level, settings) {
             .catch(function (err) { return console.log(err); });
     }
     else {
-        throw Error(errors.modeErr);
+        throw Error(Errors.Mode);
     }
 }
 function setupLineFormat(content, timestamp, level) {
-    content = (level.prefix + ': ' + content);
+    content = (level.Prefix + ': ' + content);
     if (timestamp) {
         var time = '[' + new Date().toISOString() + '] ';
         return (time + content);
@@ -173,7 +174,7 @@ function setupLineFormat(content, timestamp, level) {
 }
 function setupJsonFormat(content, timestamp, level) {
     var json = {
-        level: level.prefix,
+        level: level.Prefix,
         message: content,
     };
     if (timestamp) {
@@ -186,3 +187,4 @@ function writeToFile(content, filePath) {
         return fs_1.default.appendFile(filePath, content, (function (err) { return !!err ? rej(err) : res(); }));
     });
 }
+exports.default = jetLogger();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jet-logger",
-  "version": "1.2.6",
+  "version": "1.3.0",
   "description": "A super quick, easy to setup logging tool for NodeJS/TypeScript.",
   "main": "./lib/index.js",
   "typings": "./lib/index.d.ts",
@@ -8,7 +8,8 @@
     "lib": "lib"
   },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "npx ts-node ./test",
+    "build": "tsc -p tsconfig.build.json"
   },
   "repository": {
     "type": "git",

package/tsconfig.build.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": [
+    "./node_modules",
+    "test"
+  ]
+}

package/lib/JetLogger.d.ts

@@ -1,31 +0,0 @@
-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 {};