stonyx 0.0.5 → 0.0.7

package/README.md

@@ -28,7 +28,8 @@ db: {
 ```
 The above setting will expose the `log.db()` method, which will output in white.
 Alternatively you can provide a `logMethod` setting if you would rather use a different alias that
-does not match the class name.
+does not match the class name, and `logTimestamp` as a true if you wish your log to include timestamp.
+`stonyx/log` fully exposes the `chronicle` object. See Chronicle documentation for more information.
 
 ```js
 // environment.js

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stonyx",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "Base stonyx framework module",
   "main": "main.js",
   "type": "module",
@@ -28,7 +28,9 @@
     "url": "https://github.com/abofs/stonyx/issues"
   },
   "dependencies": {
-    "@stonyx/utils": "^0.0.2",
     "node-chronicle": "^0.2.0"
+  },
+  "devDependencies": {
+    "@stonyx/utils": "^0.0.4"
   }
 }

package/src/main.js

@@ -32,25 +32,37 @@ export default class Stonyx {
     if (!rootPath) throw new Error('Stonyx requires root project\'s path on startup');
 
     this.config = config;
+    this.chronicle = new Chronicle({ additionalLogs: { title: 'green' }});
 
     Stonyx.initialized = true;
 
-    this.modules = await loadModules(config, rootPath);
-    this.chronicle = new Chronicle({ additionalLogs: { title: 'green', ...this.classColorConfigs }});
+    this.modules = await loadModules(config, rootPath, this.chronicle);
+    this.configureUserLogs();
   }
 
-  get classColorConfigs() {
-    const colors = {};
+  /**
+   * Allows users to define their own log for any extra class via environment config
+   * { 
+   *   myClass: {
+   *     logColor: 'purple',
+   *     logMethod: 'highlight'
+   *     logTimestamp: true
+   *   }
+   & }
+   */
+  configureUserLogs() {
+    const { chronicle } = this;
 
     for (const [ className, config ] of Object.entries(this.config)) {
       if (!config || typeof config !== 'object') continue;
-      if (!config.logColor) continue;
+      if (chronicle[className]) continue;
 
-      const logMethod = config.logMethod || className;
-      colors[logMethod] = config.logColor;
-    }
+      const { logColor, logMethod, logTimestamp } = config;
+
+      if (!logColor) continue;
 
-    return colors;
+      chronicle.defineType(logMethod || className, logColor, { logTimestamp: !!logTimestamp });
+    }
   }
   
   static get log() {

package/src/modules.js

@@ -4,7 +4,7 @@
 
 import { readFile } from '@stonyx/utils/file';
 
-export default async (config, rootPath) => {
+export default async (config, rootPath, chronicle) => {
   const modules = [];
   const initPromises = [];
   const rootPackage = await readFile(`${rootPath}/package.json`, { json: true });
@@ -30,12 +30,18 @@ export default async (config, rootPath) => {
     if (!keywords.includes('stonyx-async')) continue;
 
     try {
+
       // Load & Configure Async Modules
       const { default: moduleConfig } = await import(`${rootPath}/node_modules/${moduleName}/config/environment.js`);
 
       const module = moduleName.split('/').pop();
       const userConfig = config[module] || {};
-      config[module] = { ...moduleConfig, ...userConfig };
+      const finalConfig = { ...moduleConfig, ...userConfig };
+      config[module] = finalConfig;
+
+      // Configure module-specific logging
+      const { logColor, logMethod, logTimestamp } = finalConfig;
+      if (logColor) chronicle.defineType(logMethod || module, logColor, { logTimestamp: !!logTimestamp });
   
       const { main: entryPoint } = modulePackage; 
       const { default: moduleClass } = await import(`${rootPath}/node_modules/${moduleName}/${entryPoint}`);