bugfix, test & readme

.gitignore

@@ -1 +1,2 @@
 node_modules
+logs

README.md

@@ -0,0 +1,11 @@
+# Navy's logger
+
+Simple logger I wrote to have a unified system for logging throughout my projects.
+
+## TODO
+- Automatic file rotation, currently only rotates files on startup
+- Discord webhook, need to write a separate package for that, don't want to add the entirety of d.js as a dep just for a webhook
+
+## Features
+Split into Master and Client for logging between processes, where master resides on the master process and the clients on the spawned processes.  
+Should be fairly trivial to modify it to work across nodes with websockets.

package.json

@@ -1,16 +1,20 @@
 {
-  "name": "logger",
+  "name": "@navy.gif/logger",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Logging thing",
   "main": "index.js",
   "author": "Navy.gif",
   "license": "MIT",
   "private": false,
+  "files": ["src"],
   "devDependencies": {
     "eslint": "^8.26.0"
   },
   "dependencies": {
     "chalk": "^4.1.2",
     "moment": "^2.29.4"
+  },
+  "scripts": {
+    "test": "node test/test.js"
   }
 }

src/MasterLogger.js

@@ -41,17 +41,20 @@ class MasterLogger {
     constructor (options = {}) {
         
         this.directory = path.resolve(options.directory || './logs');
-        if (!fs.stat(this.directory)) fs.mkdirSync(this.directory, { recursive: true });
+        if (!fs.existsSync(this.directory)) fs.mkdirSync(this.directory, { recursive: true });
-        const { customTypes = [], customStreams = [], typeMappings = {}, customColors = {}, debug = false } = options;
+        const { customTypes = [], customStreams = [], customTypeMapping = {}, customColors = {}, debug = false } = options;
         this._debug = debug;
         
         this.types = [ ...customTypes, ...Defaults.Types ];
-        this.colours = { ...Defaults.colours, ...customColors };
+        this.colours = { ...Defaults.Colours, ...customColors };
 
         this.streamTypes = [ ...customStreams, 'error', 'default' ];
-        this.streamTypeMapping = { ...Defaults.TypeStream, ...typeMappings };
+        this.streamTypeMapping = { ...Defaults.TypeStream, ...customTypeMapping };
         // eslint-disable-next-line no-return-assign
-        this.writeStreams = this.streamTypes.reduce((acc, type) => acc[type] = this.loadFile(type), {});
+        this.writeStreams = this.streamTypes.reduce((acc, type) => {
+            acc[type] = this.loadFile(type);
+            return acc;
+        }, {});
 
     }
 
@@ -71,7 +74,7 @@ class MasterLogger {
         
         const streamType = this.streamTypeMapping[type] || 'default';
         if (this.writeStreams[streamType]) this.writeStreams[streamType].write(`\n${type}${spacer} ${header}: ${text}`);
-        else console.log(`${chalk.red(`[LOGGER] Missing file stream for ${type}`)}`); // eslint-disable-line no-console
+        else console.log(`${chalk.red(`[LOGGER] Missing file stream for ${streamType}`)}`); // eslint-disable-line no-console
 
     }
 
@@ -108,8 +111,9 @@ class MasterLogger {
     }
 
     _shard (shard) {
+        if (!shard) return 'controller';
         const id = `${shard.id < 10 ? `0${shard.id}` : shard.id}`;
-        return shard ? `shard${id}` : 'manager';
+        return `shard${id}`;
     }
 
     get date () {

test/test.js

@@ -0,0 +1,13 @@
+/* eslint-disable no-console */
+const { MasterLogger } = require('../');
+
+const logger = new MasterLogger({ debug: true, customStreams: [ 'debug' ], customTypeMapping: { debug: 'debug' } });
+const { types, colours, streamTypes, streamTypeMapping } = logger; // , writeStreams
+
+console.log(types, colours, streamTypes, streamTypeMapping); // , writeStreams
+
+logger.info('Info test');
+logger.status('Status test');
+logger.debug('Debug test');
+logger.warn('Warn test');
+logger.error('Error test');