Only show debug log in development mode

package.json

@@ -112,6 +112,11 @@
 					"default": true,
 					"description": "Whether to show decorations on vscode start."
 				},
+				"cursorless.debug": {
+					"type": "boolean",
+					"default": false,
+					"description": "Whether to show debug logs."
+				},
 				"cursorless.pendingEditDecorationTime": {
 					"type": "integer",
 					"default": 100,

src/core/Debug.ts

@@ -0,0 +1,121 @@
+import {
+  Disposable,
+  ExtensionMode,
+  Location,
+  TextEditorSelectionChangeEvent,
+  window,
+  workspace,
+} from "vscode";
+import { SyntaxNode, TreeCursor } from "web-tree-sitter";
+import { Graph } from "../typings/Types";
+
+const originalDebugLog = console.debug;
+const disabledDebugLog = () => {};
+
+console.debug = disabledDebugLog;
+
+export default class Debug {
+  getNodeAtLocation?: any;
+  disposable?: Disposable;
+
+  constructor(private graph: Graph) {
+    this.graph.extensionContext.subscriptions.push(this);
+
+    this.evaluateSetting = this.evaluateSetting.bind(this);
+
+    switch (this.graph.extensionContext.extensionMode) {
+      // Development mode. Always enable.
+      case ExtensionMode.Development:
+        this.enableDebugLog();
+        break;
+      // Test mode. Always disable.
+      case ExtensionMode.Test:
+        this.disableDebugLog();
+        break;
+      // Production mode. Enable based on user setting.
+      case ExtensionMode.Production:
+        this.evaluateSetting();
+        workspace.onDidChangeConfiguration(this.evaluateSetting);
+        break;
+    }
+  }
+
+  init(getNodeAtLocation: any) {
+    this.getNodeAtLocation = getNodeAtLocation;
+  }
+
+  dispose() {
+    if (this.disposable) {
+      this.disposable.dispose();
+    }
+  }
+
+  private enableDebugLog() {
+    console.debug = originalDebugLog;
+    this.disposable = window.onDidChangeTextEditorSelection(
+      this.logBranchTypes()
+    );
+  }
+
+  private disableDebugLog() {
+    console.debug = disabledDebugLog;
+    this.dispose();
+  }
+
+  private evaluateSetting() {
+    const debugEnabled = workspace
+      .getConfiguration("cursorless")
+      .get<boolean>("debug")!;
+    if (debugEnabled) {
+      this.enableDebugLog();
+    } else {
+      this.disableDebugLog();
+    }
+  }
+
+  private logBranchTypes() {
+    return (event: TextEditorSelectionChangeEvent) => {
+      const location = new Location(
+        window.activeTextEditor!.document.uri,
+        event.selections[0]
+      );
+
+      let node: SyntaxNode;
+      try {
+        node = this.getNodeAtLocation(location);
+      } catch (error) {
+        return;
+      }
+
+      const ancestors: SyntaxNode[] = [node];
+      while (node.parent != null) {
+        ancestors.unshift(node.parent);
+        node = node.parent;
+      }
+
+      const cursor = node.tree.walk();
+      this.print(cursor, 0);
+
+      for (let i = 1; i < ancestors.length; ++i) {
+        cursor.gotoFirstChild();
+        while (cursor.currentNode().id !== ancestors[i].id) {
+          if (!cursor.gotoNextSibling()) {
+            return;
+          }
+        }
+        this.print(cursor, i);
+      }
+
+      const leafText = ancestors[ancestors.length - 1].text
+        .replace(/\s+/g, " ")
+        .substring(0, 100);
+      console.debug(">".repeat(ancestors.length), `"${leafText}"`);
+    };
+  }
+
+  private print(cursor: TreeCursor, depth: number) {
+    const field = cursor.currentFieldName();
+    const fieldText = field != null ? `${field}: ` : "";
+    console.debug(">".repeat(depth + 1), `${fieldText}${cursor.nodeType}`);
+  }
+}

src/extension.ts

@@ -2,7 +2,6 @@ import * as vscode from "vscode";
 import graphFactories from "./util/graphFactories";
 import { Graph } from "./typings/Types";
 import makeGraph, { FactoryMap } from "./util/makeGraph";
-import { logBranchTypes } from "./util/debug";
 import { ThatMark } from "./core/ThatMark";
 import { TestCaseRecorder } from "./testUtil/TestCaseRecorder";
 import { getCommandServerApi, getParseTreeApi } from "./util/getExtensionApi";
@@ -18,6 +17,7 @@ export async function activate(context: vscode.ExtensionContext) {
     extensionContext: () => context,
     commandServerApi: () => commandServerApi,
   } as FactoryMap<Graph>);
+  graph.debug.init(getNodeAtLocation);
   graph.snippets.init();
   await graph.decorations.init();
   graph.hatTokenMap.init();
@@ -95,12 +95,7 @@ export async function activate(context: vscode.ExtensionContext) {
     }
   }
 
-  context.subscriptions.push(
-    cursorlessRecordTestCaseDisposable,
-    vscode.window.onDidChangeTextEditorSelection(
-      logBranchTypes(getNodeAtLocation)
-    )
-  );
+  context.subscriptions.push(cursorlessRecordTestCaseDisposable);
 
   return {
     thatMark,

src/test/suite/recorded.test.ts

@@ -17,11 +17,9 @@ import {
   SerializedMarks,
 } from "../../testUtil/toPlainObject";
 import { getCursorlessApi } from "../../util/getExtensionApi";
-import { enableDebugLog } from "../../util/debug";
 import { extractTargetedMarks } from "../../testUtil/extractTargetedMarks";
 import asyncSafety from "./asyncSafety";
 import { ReadOnlyHatMap } from "../../core/IndividualHatMap";
-import { mockPrePhraseGetVersion } from "../mockPrePhraseGetVersion";
 import { openNewEditor } from "../openNewEditor";
 import getRecordedTestPaths from "./getRecordedTestPaths";
 
@@ -39,8 +37,6 @@ suite("recorded test cases", async function () {
   this.timeout("100s");
   this.retries(5);
 
-  enableDebugLog(false);
-
   teardown(() => {
     sinon.restore();
   });

src/typings/Types.ts

@@ -11,6 +11,7 @@ import Decorations from "../core/Decorations";
 import FontMeasurements from "../core/FontMeasurements";
 import { CommandServerApi } from "../util/getExtensionApi";
 import { ReadOnlyHatMap } from "../core/IndividualHatMap";
+import Debug from "../core/Debug";
 
 /**
  * A token within a text editor, including the current display line of the token
@@ -445,6 +446,11 @@ export interface Graph {
    * API object for interacting with the command server, if it exists
    */
   readonly commandServerApi: CommandServerApi | null;
+
+  /**
+   * Debug logger
+   */
+  readonly debug: Debug;
 }
 
 export type NodeMatcherValue = {

src/util/graphFactories.ts

@@ -7,6 +7,7 @@ import { Snippets } from "../core/Snippets";
 import { RangeUpdater } from "../core/updateSelections/RangeUpdater";
 import Decorations from "../core/Decorations";
 import FontMeasurements from "../core/FontMeasurements";
+import Debug from "../core/Debug";
 
 type ConstructorMap<T> = {
   [P in keyof T]: new (t: T) => T[P];
@@ -20,6 +21,7 @@ const graphConstructors: Partial<ConstructorMap<Graph>> = {
   fontMeasurements: FontMeasurements,
   snippets: Snippets,
   rangeUpdater: RangeUpdater,
+  debug: Debug,
 };
 
 const graphFactories: Partial<FactoryMap<Graph>> = Object.fromEntries(