Only show debug log in development mode

package.json

@@ -109,6 +109,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/extension.ts

@@ -2,16 +2,18 @@ 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 { initDebug, debugSetNodeAtLocation } from "./util/debug";
 import { ThatMark } from "./core/ThatMark";
 import { TestCaseRecorder } from "./testUtil/TestCaseRecorder";
 import { getCommandServerApi, getParseTreeApi } from "./util/getExtensionApi";
 import isTesting from "./testUtil/isTesting";
 import CommandRunner from "./core/commandRunner/CommandRunner";
 
 export async function activate(context: vscode.ExtensionContext) {
+  initDebug(context);
   const { getNodeAtLocation } = await getParseTreeApi();
   const commandServerApi = await getCommandServerApi();
+  debugSetNodeAtLocation(getNodeAtLocation);
 
   const graph = makeGraph({
     ...graphFactories,
@@ -95,12 +97,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/util/debug.ts

@@ -1,16 +1,73 @@
-import * as vscode from "vscode";
+import {
+  Disposable,
+  ExtensionContext,
+  ExtensionMode,
+  Location,
+  TextEditorSelectionChangeEvent,
+  window,
+  workspace,
+} from "vscode";
 import { SyntaxNode, TreeCursor } from "web-tree-sitter";
 
-export function logBranchTypes(getNodeAtLocation: any) {
-  return (event: vscode.TextEditorSelectionChangeEvent) => {
-    const location = new vscode.Location(
-      vscode.window.activeTextEditor!.document.uri,
+const originalDebugLog = console.debug;
+let _getNodeAtLocation: any;
+let disposable: Disposable;
+
+export function initDebug(context: ExtensionContext) {
+  switch (context.extensionMode) {
+    // Development mode. Always enable.
+    case ExtensionMode.Development:
+      enableDebugLog();
+      break;
+    // Test mode. Always disable.
+    case ExtensionMode.Test:
+      disableDebugLog();
+      break;
+    // Production mode. Enable based on user setting.
+    case ExtensionMode.Production:
+      evaluateSetting();
+      workspace.onDidChangeConfiguration(evaluateSetting);
+      break;
+  }
+}
+
+export function debugSetNodeAtLocation(getNodeAtLocation: any) {
+  _getNodeAtLocation = getNodeAtLocation;
+}
+
+function enableDebugLog() {
+  console.debug = originalDebugLog;
+  disposable = window.onDidChangeTextEditorSelection(logBranchTypes());
+}
+
+function disableDebugLog() {
+  console.debug = () => {};
+  if (disposable) {
+    disposable.dispose();
+  }
+}
+
+function evaluateSetting() {
+  const debugEnabled = workspace
+    .getConfiguration("cursorless")
+    .get<boolean>("debug")!;
+  if (debugEnabled) {
+    enableDebugLog();
+  } else {
+    disableDebugLog();
+  }
+}
+
+function logBranchTypes() {
+  return (event: TextEditorSelectionChangeEvent) => {
+    const location = new Location(
+      window.activeTextEditor!.document.uri,
       event.selections[0]
     );
 
     let node: SyntaxNode;
     try {
-      node = getNodeAtLocation(location);
+      node = _getNodeAtLocation(location);
     } catch (error) {
       return;
     }
@@ -21,12 +78,6 @@ export function logBranchTypes(getNodeAtLocation: any) {
       node = node.parent;
     }
 
-    const print = (cursor: TreeCursor, depth: number) => {
-      const field = cursor.currentFieldName();
-      const fieldText = field != null ? `${field}: ` : "";
-      console.debug(">".repeat(depth + 1), `${fieldText}${cursor.nodeType}`);
-    };
-
     const cursor = node.tree.walk();
     print(cursor, 0);
 
@@ -47,7 +98,8 @@ export function logBranchTypes(getNodeAtLocation: any) {
   };
 }
 
-const originalDebugLog = console.debug;
-export function enableDebugLog(enable: boolean) {
-  console.debug = enable ? originalDebugLog : () => {};
-}
+const print = (cursor: TreeCursor, depth: number) => {
+  const field = cursor.currentFieldName();
+  const fieldText = field != null ? `${field}: ` : "";
+  console.debug(">".repeat(depth + 1), `${fieldText}${cursor.nodeType}`);
+};