jet-logger 2.0.1 → 2.1.1

package/README.md

@@ -1,116 +1,12 @@
-# Jet-Logger
-
-> A super quick, easy to setup logging tool for NodeJS/TypeScript.
-
-
-## 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, 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
-```batch
-$ npm install --save jet-logger
-```
-
-### Guide
-The logger package's default export is an instance of the `JetLogger` class. This default export uses all the default settings. If you wish to pass your own settings you can import the `JetLogger` class and pass parameters to the constructor to configure your own custom logger.
-
-- 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` class and calling it with whatever options you want.
-<br>
-
-- There are 4 functions on Logger to print logs.
-  - `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.
-
-
-````typescript
-/* Some script that is run before the route script */
-
-// Apply logger settings (Note you could also using a tool "dotenv" to set env variables)
-// These must be set before logger is imported
-const logFilePath = path.join(__dirname, '../sampleProject.log');
-process.env.JET_LOGGER_MODE = LoggerModes.File; // Can also be Console, Custom, or Off
-process.env.JET_LOGGER_FILEPATH = logFilePath;
-
-
-/* In you route script */
-
-import { OK } from 'http-status-codes';
-import { Router, Request, Response } from 'express';
-import logger from 'jet-logger';
-
-
-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',
-  });
-});
-````
-
-
-- The previous code-snippet will  show the following content when printed:
-````
-[2020-10-11T04:50:59.339Z] INFO: hello jet-logger
-[2020-10-11T04:50:59.341Z] IMPORTANT: hello jet-logger
-[2020-10-11T04:50:59.341Z] WARNING: hello jet-logger
-[2020-10-11T04:50:59.342Z] ERROR: hello jet-logger
-[2020-10-11T04:50:59.372Z] ERROR: Error: Demo print full error object
-    at Object.<anonymous> (C:\Projects\jet-logger\sample-project\src\index.ts:21:12)
-    at Module._compile (internal/modules/cjs/loader.js:956:30)
-    at Module.m._compile (C:\Users\seanp\AppData\Roaming\npm\node_modules\ts-node\src\index.ts:536:23)
-    at Module._extensions..js (internal/modules/cjs/loader.js:973:10)
-    at Object.require.extensions.<computed> [as .ts] (C:\Users\seanp\AppData\Roaming\npm\node_modules\ts-node\src\index.ts:539:12)
-    at Module.load (internal/modules/cjs/loader.js:812:32)
-    at Function.Module._load (internal/modules/cjs/loader.js:724:14)
-    at Function.Module.runMain (internal/modules/cjs/loader.js:1025:10)
-    at main (C:\Users\seanp\AppData\Roaming\npm\node_modules\ts-node\src\bin.ts:212:14)
-    at Object.<anonymous> (C:\Users\seanp\AppData\Roaming\npm\node_modules\ts-node\src\bin.ts:470:3)
-````
-
-
-### Using a custom logger 
-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, TCustomLogFn } from 'jet-logger';
-import { thirdPartyLoggingApp } from 'thirdPartyLoggingApplicationLib';
-
-
-// Needs to be implemented
-const customSend: TCustomLogFn = (timestamp: Date, level: string, content: unknown) => {
-  thirdPartyLoggingApp.doStuff(...);
-}
-
-router.get('api/users', async (req: Request, res: Reponse) => {
-  const logger = new JetLogger(LoggerModes.CUSTOM, '', true, true, undefined, customSend);
-  logger.info(req.params.msg);
-  return res.status(OK).json({
-    message: 'console_mode',
-  });
-});
-````
+# Jet-Logger ✈️
+
+> Super fast, zero-dependency logging for Node.js and TypeScript projects.
+
+[![npm version](https://img.shields.io/npm/v/jet-logger?logo=npm&label=npm)](https://www.npmjs.com/package/jet-logger)
+[![npm downloads](https://img.shields.io/npm/dm/jet-logger?color=orange)](https://www.npmjs.com/package/jet-logger)
+[![License](https://img.shields.io/npm/l/jet-logger)](https://github.com/seanpmaxwell/jet-logger/blob/master/LICENSE)
+[![TypeScript definitions](https://img.shields.io/badge/TypeScript-ready-3178c6?logo=typescript&logoColor=white)](https://www.npmjs.com/package/jet-logger)
+
+Jet-Logger is an easy-to-configure logger that can print to the console, write to disk, or forward events to your own transport. Configure it entirely through environment variables or in code, and get colorized output, timestamps, and JSON log formatting out-of-the-box.
+
+Please refer to the official <a href="https://github.com/seanpmaxwell/jet-logger">github repo</a> for the most up-to-date documentation.

package/dist/cjs/JetLogger.js

@@ -0,0 +1,239 @@
+/* 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/cjs/index.js

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

package/dist/esm/JetLogger.js

@@ -0,0 +1,239 @@
+/* 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/index.js

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

package/dist/types/JetLogger.d.ts

@@ -0,0 +1,75 @@
+/******************************************************************************
+                                   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;

package/dist/types/index.d.ts

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

package/package.json

@@ -1,15 +1,31 @@
 {
   "name": "jet-logger",
-  "version": "2.0.1",
+  "version": "2.1.1",
   "description": "A super quick, easy to setup logging tool for NodeJS/TypeScript.",
-  "main": "./lib/index.js",
-  "typings": "./lib/index.d.ts",
-  "directories": {
-    "lib": "lib"
+  "type": "module",
+  "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.js",
+      "types": "./dist/types/index.d.ts"
+    }
   },
+  "files": [
+    "dist"
+  ],
   "scripts": {
-    "test": "npx ts-node ./test",
-    "build": "tsc -p tsconfig.build.json"
+    "build": "rm -rf ./dist && tsc -p tsconfig.esm.json && tsc -p tsconfig.cjs.json && tsc -p tsconfig.types.json",
+    "clean-install": "rm -rf ./node_modules && rm -r package-lock.json && npm i",
+    "lint": "eslint .",
+    "format": "eslint --fix .",
+    "playground": "tsx ./test/playground.ts",
+    "pre-publish": "mv README.md README-git && mv README-npm README.md",
+    "post-publish": "mv README.md README-npm && mv README-git README.md",
+    "test": "NODE_ENV=test vitest"
   },
   "repository": {
     "type": "git",
@@ -20,25 +36,21 @@
     "logging",
     "log",
     "console",
-    "print",
     "node",
     "nodejs",
-    "overnight",
-    "overnightjs",
-    "overnightjs/logger",
-    "winston",
+    "node.js",
+    "typescript",
+    "ts",
+    "typescript-logger",
+    "typescript-logging",
+    "node-logger",
+    "node-logging",
     "jet",
+    "jet-logger",
+    "jetlogger",
     "simple",
     "easy",
-    "quick",
-    "jet-logger",
-    "best",
-    "type",
-    "typescript",
-    "script",
-    "env",
-    "environment",
-    "variables"
+    "quick"
   ],
   "author": "sean maxwell",
   "license": "MIT",
@@ -50,34 +62,18 @@
     "colors": "1.3.0"
   },
   "devDependencies": {
-    "@types/node": "^14.11.8",
-    "@typescript-eslint/eslint-plugin": "^4.4.0",
-    "@typescript-eslint/parser": "^4.4.0",
-    "eslint": "^7.11.0",
-    "typescript": "^4.0.3"
-  },
-  "eslintConfig": {
-    "parser": "@typescript-eslint/parser",
-    "plugins": [
-      "@typescript-eslint"
-    ],
-    "extends": [
-      "eslint:recommended",
-      "plugin:@typescript-eslint/recommended",
-      "plugin:@typescript-eslint/recommended-requiring-type-checking"
-    ],
-    "parserOptions": {
-      "project": "./tsconfig.json"
-    },
-    "rules": {
-      "no-console": 0,
-      "no-extra-boolean-cast": 0,
-      "@typescript-eslint/restrict-plus-operands": 0,
-      "@typescript-eslint/explicit-module-boundary-types": 0,
-      "@typescript-eslint/no-explicit-any": 0,
-      "@typescript-eslint/no-unsafe-member-access": 0,
-      "@typescript-eslint/no-unsafe-call": 0,
-      "@typescript-eslint/no-unsafe-assignment": 0
-    }
+    "@eslint/js": "^9.26.0",
+    "@stylistic/eslint-plugin": "^5.6.1",
+    "@types/node": "^22.8.1",
+    "eslint": "^9.26.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-n": "^17.17.0",
+    "eslint-plugin-prettier": "^5.5.4",
+    "jiti": "^2.3.3",
+    "prettier": "^3.7.4",
+    "typescript": "~5.9.3",
+    "tsx": "^4.19.1",
+    "typescript-eslint": "^8.50.0",
+    "vitest": "^4.0.15"
   }
 }

package/lib/JetLogger.d.ts

@@ -1,30 +0,0 @@
-export declare enum LoggerModes {
-    Console = "CONSOLE",
-    File = "FILE",
-    Custom = "CUSTOM",
-    Off = "OFF"
-}
-export declare enum Formats {
-    Line = "LINE",
-    Json = "JSON"
-}
-export declare type TCustomLogFn = (timestamp: Date, prefix: string, content: unknown) => void;
-export declare class JetLogger {
-    private mode;
-    private filePath;
-    private timestamp;
-    private format;
-    private customLogFn;
-    constructor(mode?: LoggerModes, filepath?: string, filepathDatetimeParam?: boolean, timestamp?: boolean, format?: Formats, customLogFn?: TCustomLogFn);
-    private addDatetimeToFileName;
-    info(content: unknown, printFull?: boolean): void;
-    imp(content: unknown, printFull?: boolean): void;
-    warn(content: unknown, printFull?: boolean): void;
-    err(content: unknown, printFull?: boolean): void;
-    private printLog;
-    private setupLineFormat;
-    private setupJsonFormat;
-    private writeToFile;
-}
-declare const _default: JetLogger;
-export default _default;

package/lib/JetLogger.js

@@ -1,178 +0,0 @@
-"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',
-    },
-    Important: {
-        Color: 'magenta',
-        Prefix: 'IMPORTANT',
-    },
-    Warning: {
-        Color: 'yellow',
-        Prefix: 'WARNING',
-    },
-    Error: {
-        Color: 'red',
-        Prefix: 'ERROR',
-    }
-};
-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 JetLogger = (function () {
-    function JetLogger(mode, filepath, filepathDatetimeParam, timestamp, format, customLogFn) {
-        this.mode = LoggerModes.Console;
-        this.filePath = 'jet-logger.log';
-        this.timestamp = true;
-        this.format = Formats.Line;
-        this.customLogFn = function () { return ({}); };
-        if (mode !== undefined) {
-            this.mode = mode;
-        }
-        else if (!!process.env.JET_LOGGER_MODE) {
-            this.mode = process.env.JET_LOGGER_MODE.toUpperCase();
-        }
-        if (filepath !== undefined) {
-            this.filePath = filepath;
-        }
-        else if (!!process.env.JET_LOGGER_FILEPATH) {
-            this.filePath = process.env.JET_LOGGER_FILEPATH;
-        }
-        var filePathDatetime = true;
-        if (filepathDatetimeParam !== undefined) {
-            filePathDatetime = filepathDatetimeParam;
-        }
-        else if (!!process.env.JET_LOGGER_FILEPATH_DATETIME) {
-            var envVar = process.env.JET_LOGGER_FILEPATH_DATETIME;
-            filePathDatetime = envVar.toUpperCase() === 'TRUE';
-        }
-        if (timestamp !== undefined) {
-            this.timestamp = timestamp;
-        }
-        else if (!!process.env.JET_LOGGER_TIMESTAMP) {
-            var envVar = process.env.JET_LOGGER_TIMESTAMP;
-            this.timestamp = (envVar.toUpperCase() === 'TRUE');
-        }
-        if (format !== undefined) {
-            this.format = format;
-        }
-        else if (!!process.env.JET_LOGGER_FORMAT) {
-            this.format = process.env.JET_LOGGER_FORMAT.toUpperCase();
-        }
-        if (filePathDatetime) {
-            this.filePath = this.addDatetimeToFileName(this.filePath);
-        }
-        if (customLogFn !== undefined) {
-            this.customLogFn = customLogFn;
-        }
-    }
-    JetLogger.prototype.addDatetimeToFileName = function (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('/');
-    };
-    JetLogger.prototype.info = function (content, printFull) {
-        this.printLog(content, !!printFull, Levels.Info);
-    };
-    JetLogger.prototype.imp = function (content, printFull) {
-        this.printLog(content, !!printFull, Levels.Important);
-    };
-    JetLogger.prototype.warn = function (content, printFull) {
-        this.printLog(content, !!printFull, Levels.Warning);
-    };
-    JetLogger.prototype.err = function (content, printFull) {
-        this.printLog(content, !!printFull, Levels.Error);
-    };
-    JetLogger.prototype.printLog = function (contentParam, printFull, level) {
-        if (this.mode === LoggerModes.Off) {
-            return;
-        }
-        var content;
-        if (printFull) {
-            content = util_1.default.inspect(contentParam);
-        }
-        else {
-            content = String(contentParam);
-        }
-        if (this.mode === LoggerModes.Custom) {
-            if (!!this.customLogFn) {
-                return this.customLogFn(new Date(), level.Prefix, content);
-            }
-            else {
-                throw Error(Errors.CustomLogFn);
-            }
-        }
-        if (this.format === Formats.Line) {
-            content = this.setupLineFormat(content, level);
-        }
-        else if (this.format === Formats.Json) {
-            content = this.setupJsonFormat(content, level);
-        }
-        if (this.mode === LoggerModes.Console) {
-            var colorFn = colors_1.default[level.Color];
-            console.log(colorFn(content));
-        }
-        else if (this.mode === LoggerModes.File) {
-            this.writeToFile(content + '\n');
-        }
-        else {
-            throw Error(Errors.Mode);
-        }
-    };
-    JetLogger.prototype.setupLineFormat = function (content, level) {
-        content = (level.Prefix + ': ' + content);
-        if (this.timestamp) {
-            var time = '[' + new Date().toISOString() + '] ';
-            return (time + content);
-        }
-        return content;
-    };
-    JetLogger.prototype.setupJsonFormat = function (content, level) {
-        var json = {
-            level: level.Prefix,
-            message: content,
-        };
-        if (this.timestamp) {
-            json.timestamp = new Date().toISOString();
-        }
-        return JSON.stringify(json);
-    };
-    JetLogger.prototype.writeToFile = function (content) {
-        fs_1.default.appendFile(this.filePath, content, function (err) {
-            if (!!err) {
-                console.error(err);
-            }
-        });
-    };
-    return JetLogger;
-}());
-exports.JetLogger = JetLogger;
-exports.default = new JetLogger();

package/lib/index.d.ts

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

package/lib/index.js

@@ -1,11 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-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; } });