ntlogger 2.3.0 → 2.4.0

package/README.md

@@ -1,90 +1,90 @@
-# NightTimeLogger
-
-NightTimeLogger is a custom logging wrapper built on top of the Winston logging library. It provides a ready-to-go solution for integrating advanced logging functionalities into Node.js applications with ease.
-
-[![Node.js Package](https://github.com/NightSquawk/NightTimeLogger/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/NightSquawk/NightTimeLogger/actions/workflows/main.yml)
-
-## Features
-
-- Custom log levels for fine-grained control over logging output.
-- Dynamic color generation for visually appealing log messages.
-- Custom session ID generation for tracking log sessions.
-- Support for both file and console log formatters.
-- Ability to configure log levels and formats to suit specific requirements.
-
-## Installation
-
-To install NightTimeLogger, use npm:
-
-```bash
-npm install ntlogger
-```
-
-## Usage
-
-```javascript
-// Import the logger
-const logger = require('ntlogger');
-
-// Create a logger instance
-const log = logger('MyApp');
-
-// Log messages at different levels
-log.info('Informational message');
-log.warn('Warning message');
-log.error('Error message');
-log.debug('Debugging message');
-log.trace('Trace message');
-
-// Log internal messages
-log.internal('Internal message');
-```
-
-## Output
-
-Check out [Quick Start](https://github.com/NightSquawk/NightTimeLogger/blob/main/examples/quick-start.js)
-![Quick Start](https://github.com/NightSquawk/NightTimeLogger/blob/main/images/quick-start.png)
-
-
-Check out [Full Configuration](https://github.com/NightSquawk/NightTimeLogger/blob/main/examples/full-configuration.js)
-![Full Configuration](https://github.com/NightSquawk/NightTimeLogger/blob/main/images/full-configuration.png)
-
-## Configuration Options
-
-- `level`: The default log level for the logger instance.
-- `console`: Whether to enable console logging. Defaults to `true`.
-- `file`: Whether to enable file logging. Defaults to `true`.
-- `path`: The directory path where log files will be saved.
-- `maxSize`: The maximum size (in bytes) for each log file.
-- `maxFiles`: The maximum number of log files to retain (rotating file strategy).
-- `timestamp`: Whether to include timestamps in log messages. Defaults to `true`.
-- `debug`: Whether to enable debug mode, which logs internal messages. Defaults to `false`.
-
-## Custom Levels and Colors
-NightTimeLogger provides custom log levels and colors for enhanced logging experience:
-
-### Levels:
-
-- trace: 5
-- debug: 4
-- info: 3
-- warn: 2
-- error: 1
-- fatal: 0
-- internal: -1
-
-### Colors:
-
-- trace: Light gray
-- debug: White
-- info: Green
-- warn: Yellow
-- error: Red
-- fatal: Magenta
-- internal: Bright yellow
-
-## File and Console Formatters
-NightTimeLogger supports both file and console log formatters. File-formatted logs are stored in the project's root `/logs` directory.
-
-## License
+# NightTimeLogger
+
+NightTimeLogger is a custom logging wrapper built on top of the Winston logging library. It provides a ready-to-go solution for integrating advanced logging functionalities into Node.js applications with ease.
+
+[![Node.js Package](https://github.com/NightSquawk/NightTimeLogger/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/NightSquawk/NightTimeLogger/actions/workflows/main.yml)
+
+## Features
+
+- Custom log levels for fine-grained control over logging output.
+- Dynamic color generation for visually appealing log messages.
+- Custom session ID generation for tracking log sessions.
+- Support for both file and console log formatters.
+- Ability to configure log levels and formats to suit specific requirements.
+
+## Installation
+
+To install NightTimeLogger, use npm:
+
+```bash
+npm install ntlogger
+```
+
+## Usage
+
+```javascript
+// Import the logger
+const logger = require('ntlogger');
+
+// Create a logger instance
+const log = logger('MyApp');
+
+// Log messages at different levels
+log.info('Informational message');
+log.warn('Warning message');
+log.error('Error message');
+log.debug('Debugging message');
+log.trace('Trace message');
+
+// Log internal messages
+log.internal('Internal message');
+```
+
+## Output
+
+Check out [Quick Start](https://github.com/NightSquawk/NightTimeLogger/blob/main/examples/quick-start.js)
+![Quick Start](https://github.com/NightSquawk/NightTimeLogger/blob/main/images/quick-start.png)
+
+
+Check out [Full Configuration](https://github.com/NightSquawk/NightTimeLogger/blob/main/examples/full-configuration.js)
+![Full Configuration](https://github.com/NightSquawk/NightTimeLogger/blob/main/images/full-configuration.png)
+
+## Configuration Options
+
+- `level`: The default log level for the logger instance.
+- `console`: Whether to enable console logging. Defaults to `true`.
+- `file`: Whether to enable file logging. Defaults to `true`.
+- `path`: The directory path where log files will be saved.
+- `maxSize`: The maximum size (in bytes) for each log file.
+- `maxFiles`: The maximum number of log files to retain (rotating file strategy).
+- `timestamp`: Whether to include timestamps in log messages. Defaults to `true`.
+- `debug`: Whether to enable debug mode, which logs internal messages. Defaults to `false`.
+
+## Custom Levels and Colors
+NightTimeLogger provides custom log levels and colors for enhanced logging experience:
+
+### Levels:
+
+- trace: 5
+- debug: 4
+- info: 3
+- warn: 2
+- error: 1
+- fatal: 0
+- internal: -1
+
+### Colors:
+
+- trace: Light gray
+- debug: White
+- info: Green
+- warn: Yellow
+- error: Red
+- fatal: Magenta
+- internal: Bright yellow
+
+## File and Console Formatters
+NightTimeLogger supports both file and console log formatters. File-formatted logs are stored in the project's root `/logs` directory.
+
+## License
 NightTimeLogger is licensed under the [GPL-3.0 License](https://opensource.org/licenses/GPL-3.0).

package/index.js

@@ -1,58 +1,66 @@
-/*!
- * ntlogger
- * Copyright(c) 2024 Kevin R
- * GPL-3.0 Licensed
- */
-
-/**
- * Change Log:
- *
- * v2.2.3 - 04/01/2024:
- * Reduced GitHub Actions to only NPM publish
- * Fixed export
- * Modified readme and examples
- *
- * v2.2.2 - 03/31/2024:
- * Take 2 on setting up CI with GitHub Actions to NPM
- * Housekeeping
- *
- * v2.2.1 - 03/31/2024:
- * Tried and failed to setup CI with GitHub Actions to NPM
- *
- * v2.2.0 - 03/31/2024:
- * Renamed project to NightTimeLogger, no longer a daytime logger (old name was Nightly-Logger)
- * Published the project on NPM
- * Added a location parameter to the logger function
- * Modified the logger instance creation to include the location in the metadata
- * Added a map to store logger instances by location instead of one global instance
- * This allows the location to be included in the metadata of each log statement
- * Added a custom 'internal' log level to log internal messages
- * Shortened the output by removing Session from Session ID to increase line availability for messages
- * Increased log level padding to 8 characters to ensure consistent spacing
- * (this looks a bit weird, not sure if I like it but I also tried centered log levels and it no look good :( )
- * Added many configuration options to the logger function (level, internal, console, file, filename, path, maxSize, maxFiles, timestamp)
- *
- * TODO: locations has a weird bug that carries location from instance to instance, ONLY, when another instanced is called
-*          from a different file. I have no idea why this is happening.
- *         i.e. app.js calls route.js then back to app.js but the location is still route.js. This does not happen when directly
- *         calling route.js.
- * TODO: probably rewrite the whole thing to improve readability and maintainability
- * TODO: cry
- * TODO: timestamp, filename have not been tested nor implemented
- *
- * v2.1.0 - 03/17/2024:
- * Modified custom log colors to use ANSI escape codes
- * Changed the console formatter to paint the level and message with the corresponding color
- * Modified the color generation formula. Now with prettier colors!
- *
- * v2.0.0 - 01/20/2024:
- * Added bright color generation
- * Added session ID generation
- * Added separate console and file formatters
- * Added rotating file transport with 5 files of 1MB each (5MB total)
- *
- * v1.0.0 - 10/18/2023:
- * Initial release
- */
-
+/*!
+ * ntlogger
+ * Copyright(c) 2024 KR
+ * GPL-3.0 Licensed
+ */
+
+/**
+ * Change Log:
+ *
+ * v2.4.0 - 08/01/2024:
+ * [NOTE] Damn its been 4 months.. kinda. forgot to log last changes
+ * [CRITICAL] Fixed `includes` in package.json which prevented plugins folder from being pushed to npmjs.com
+ * [QA] Added test cases using jest
+ * [Feature] Added session ID to logger meta, try `console.log(log.defaultMeta.ID)`
+ * [Feature] Created the plugin jest. Added a custom transport for in memory logging and testing
+ * [Feature] Created the config var `skipCache` to allow you to create a new logger instance within the same file. (Usual behavior is to return the same instance within the same file)
+ *
+ * v2.2.3 - 04/01/2024:
+ * Reduced GitHub Actions to only NPM publish
+ * Fixed export
+ * Modified readme and examples
+ *
+ * v2.2.2 - 03/31/2024:
+ * Take 2 on setting up CI with GitHub Actions to NPM
+ * Housekeeping
+ *
+ * v2.2.1 - 03/31/2024:
+ * Tried and failed to setup CI with GitHub Actions to NPM
+ *
+ * v2.2.0 - 03/31/2024:
+ * Renamed project to NightTimeLogger, no longer a daytime logger (old name was Nightly-Logger)
+ * Published the project on NPM
+ * Added a location parameter to the logger function
+ * Modified the logger instance creation to include the location in the metadata
+ * Added a map to store logger instances by location instead of one global instance
+ * This allows the location to be included in the metadata of each log statement
+ * Added a custom 'internal' log level to log internal messages
+ * Shortened the output by removing Session from Session ID to increase line availability for messages
+ * Increased log level padding to 8 characters to ensure consistent spacing
+ * (this looks a bit weird, not sure if I like it but I also tried centered log levels and it no look good :( )
+ * Added many configuration options to the logger function (level, internal, console, file, filename, path, maxSize, maxFiles, timestamp)
+ *
+ * TODO: locations has a weird bug that carries location from instance to instance, ONLY, when another instanced is called
+*          from a different file. I have no idea why this is happening.
+ *         i.e. app.js calls route.js then back to app.js but the location is still route.js. This does not happen when directly
+ *         calling route.js.
+ * TODO: probably rewrite the whole thing to improve readability and maintainability
+ * TODO: cry
+ * TODO: timestamp, filename have not been tested nor implemented
+ *
+ * v2.1.0 - 03/17/2024:
+ * Modified custom log colors to use ANSI escape codes
+ * Changed the console formatter to paint the level and message with the corresponding color
+ * Modified the color generation formula. Now with prettier colors!
+ *
+ * v2.0.0 - 01/20/2024:
+ * Added bright color generation
+ * Added session ID generation
+ * Added separate console and file formatters
+ * Added rotating file transport with 5 files of 1MB each (5MB total)
+ *
+ * v1.0.0 - 10/18/2023:
+ * Initial release
+ */
+
 module.exports = require('./lib/logger');