ntlogger 2.2.1 → 2.2.3

package/README.md

@@ -24,7 +24,7 @@ npm install ntlogger
 
 ```javascript
 // Import the logger
-const logger = require('../lib/logger');
+const logger = require('ntlogger');
 
 // Create a logger instance
 const log = logger('MyApp');
@@ -41,10 +41,12 @@ log.internal('Internal message');
 ```
 
 ## Output
-Quick Start
+
+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)
 
-Full Configuration
+
+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

package/index.js

@@ -1 +1,58 @@
-exports.logger = require('./lib/logger');
+/*!
+ * 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
+ */
+
+module.exports = require('./lib/logger');

package/lib/logger.js

@@ -6,43 +6,9 @@
  * any Node.js project.
  *
  * Author: Kevin R. (Kvrnn#6940, Syntax#5569)
- * Date: 01/20/2024
- * Current Version: 2.1.0
+ * Date: 03/31/2024
+ * Current Version: 2.1.2
  * License: GPL-3.0
- *
- * Change Log:
- * 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, console, file, 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
  */
 const winston = require('winston');
 const crypto = require('crypto');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ntlogger",
-  "version": "2.2.1",
+  "version": "2.2.3",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/NightSquawk/NightTimeLogger.git"