Use log with CONFIG toggle for debug logging

caewok · Jan 22, 2024 · 4ea68f2 · 4ea68f2
1 parent 33c3611
commit 4ea68f2
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 15 deletions.
diff --git a/scripts/Ruler.js b/scripts/Ruler.js
@@ -37,7 +37,8 @@ import {
   tokenIsSnapped,
   iterateGridUnderLine,
   squareGridShape,
-  hexGridShape } from "./util.js";
+  hexGridShape,
+  log } from "./util.js";
 
 /**
  * Modified Ruler
@@ -497,7 +498,7 @@ function _onMouseUp(wrapped, event) {
  */
 function _getMovementToken(wrapped) {
   if ( !this.waypoints.length ) {
-    // console.debug("Waypoints length 0");
+    log("Waypoints length 0");
     return undefined;
   }
 

diff --git a/scripts/module.js b/scripts/module.js
@@ -28,6 +28,11 @@ Hooks.once("init", function() {
   // Cannot access localization until init.
   PREFER_TOKEN_CONTROL.title = game.i18n.localize(PREFER_TOKEN_CONTROL.title);
   registerGeometry();
+
+  // Configuration
+  CONFIG[MODULE_ID] = { debug: false };
+
+
   game.modules.get(MODULE_ID).api = {
     iterateGridUnderLine,
     PATCHER,

diff --git a/scripts/pathfinding/Wall.js b/scripts/pathfinding/Wall.js
@@ -19,9 +19,6 @@ PATCHES.PATHFINDING = {};
 
 // When canvas is ready, the existing walls are not created, so must re-do here.
 Hooks.on("canvasReady", async function() {
-  // console.debug(`outerBounds: ${canvas.walls.outerBounds.length}`);
-  // console.debug(`innerBounds: ${canvas.walls.innerBounds.length}`);
-
   const t0 = performance.now();
   SCENE_GRAPH.clear();
   const walls = [

diff --git a/scripts/segments.js b/scripts/segments.js
@@ -11,7 +11,7 @@ import { SPEED, MODULES_ACTIVE, MODULE_ID } from "./const.js";
 import { Settings } from "./settings.js";
 import { Ray3d } from "./geometry/3d/Ray3d.js";
 import { Point3d } from "./geometry/3d/Point3d.js";
-import { perpendicularPoints } from "./util.js";
+import { perpendicularPoints, log } from "./util.js";
 import { Pathfinder } from "./pathfinding/pathfinding.js";
 
 /**
@@ -68,7 +68,7 @@ export function _getMeasurementSegments(wrapped) {
   const t2 = performance.now();
   const newSegments = constructPathfindingSegments(segments, segmentMap);
   const t3 = performance.now();
-  //console.debug(`${newSegments.length} segments processed in ${t3-t2} ms.`);
+  log(`${newSegments.length} segments processed in ${t3-t2} ms.`);
   return newSegments;
 }
 
@@ -88,17 +88,17 @@ function calculatePathPointsForSegment(segment, token) {
   const path = pf.runPath(A, B);
   let pathPoints = Pathfinder.getPathPoints(path);
   const t1 = performance.now();
-  //console.debug(`Found ${pathPoints.length} path points between ${A.x},${A.y} -> ${B.x},${B.y} in ${t1 - t0} ms.`);
+  log(`Found ${pathPoints.length} path points between ${A.x},${A.y} -> ${B.x},${B.y} in ${t1 - t0} ms.`);
 
   // Clean the path
   const t2 = performance.now();
   pathPoints = Pathfinder.cleanPath(pathPoints);
   const t3 = performance.now();
-  //console.debug(`Cleaned to ${pathPoints?.length} path points between ${A.x},${A.y} -> ${B.x},${B.y} in ${t3 - t2} ms.`);
+  log(`Cleaned to ${pathPoints?.length} path points between ${A.x},${A.y} -> ${B.x},${B.y} in ${t3 - t2} ms.`);
 
   // If less than 3 points after cleaning, just use the original segment.
   if ( pathPoints.length < 2 ) {
-    //console.debug(`Only ${pathPoints.length} path points found.`, [...pathPoints]);
+    log(`Only ${pathPoints.length} path points found.`, [...pathPoints]);
     return [];
   }
 

diff --git a/scripts/settings.js b/scripts/settings.js
@@ -7,6 +7,7 @@ canvas
 
 import { MODULE_ID, MODULES_ACTIVE, SPEED } from "./const.js";
 import { ModuleSettingsAbstract } from "./ModuleSettingsAbstract.js";
+import { log } from "./util.js";
 
 const SETTINGS = {
   CONTROLS: {
@@ -252,15 +253,15 @@ function toggleTokenRulerWaypoint(context, add = true) {
   const position = canvas.mousePosition;
   const ruler = canvas.controls.ruler;
   if ( !canvas.tokens.active || !ruler || !ruler.active ) return;
-  // console.debug(`${add ? "add" : "remove"}TokenRulerWaypoint`);
+  log(`${add ? "add" : "remove"}TokenRulerWaypoint`);
 
   // Keep track of when we last added/deleted a waypoint.
   const now = Date.now();
   const delta = now - MOVE_TIME;
   if ( delta < 100 ) return true; // Throttle keyboard movement once per 100ms
   MOVE_TIME = now;
 
-  // console.debug(`${add ? "adding" : "removing"}TokenRulerWaypoint`);
+  log(`${add ? "adding" : "removing"}TokenRulerWaypoint`);
   if ( add ) ruler._addWaypoint(position);
   else if ( ruler.waypoints.length > 1 ) ruler._removeWaypoint(position); // Removing the last waypoint throws errors.
 }

diff --git a/scripts/util.js b/scripts/util.js
@@ -10,9 +10,7 @@ import { MODULE_ID } from "./const.js";
 
 export function log(...args) {
   try {
-    const isDebugging = game.modules.get("_dev-mode")?.api?.getPackageDebugValue(MODULE_ID);
-    if (isDebugging) console.log(MODULE_ID, "|", ...args);
-
+    if ( CONFIG[MODULE_ID].debug ) console.debug(MODULE_ID, "|", ...args);
   } catch(e) {
     // Empty
   }