Added command history

packages/common/src/index.ts

@@ -49,6 +49,7 @@ export * from "./types/ScopeProvider";
 export * from "./types/SpokenForm";
 export * from "./util/textFormatters";
 export * from "./types/snippet.types";
+export * from "./types/CommandHistory";
 export * from "./testUtil/fromPlainObject";
 export * from "./testUtil/spyToPlainObject";
 export { default as DefaultMap } from "./util/DefaultMap";

packages/common/src/types/CommandHistory.ts

@@ -0,0 +1,12 @@
+import type { CommandComplete } from "./command/command.types";
+
+export interface CommandHistory {
+  append(command: CommandComplete): Promise<void>;
+  dispose(): void;
+}
+
+export interface CommandHistoryItem {
+  date: string;
+  cursorlessVersion: string;
+  command: CommandComplete;
+}

packages/cursorless-engine/src/cursorlessEngine.ts

@@ -1,24 +1,25 @@
 import {
   Command,
+  CommandHistory,
   CommandServerApi,
   FileSystem,
   Hats,
   IDE,
   ScopeProvider,
 } from "@cursorless/common";
-import { StoredTargetMap } from "./core/StoredTargets";
-import { TreeSitter } from "./typings/TreeSitter";
 import {
   CommandRunnerDecorator,
   CursorlessEngine,
 } from "./api/CursorlessEngineApi";
 import { Debug } from "./core/Debug";
 import { HatTokenMapImpl } from "./core/HatTokenMapImpl";
 import { Snippets } from "./core/Snippets";
+import { StoredTargetMap } from "./core/StoredTargets";
 import { ensureCommandShape } from "./core/commandVersionUpgrades/ensureCommandShape";
 import { RangeUpdater } from "./core/updateSelections/RangeUpdater";
 import { CustomSpokenFormGeneratorImpl } from "./generateSpokenForm/CustomSpokenFormGeneratorImpl";
 import { LanguageDefinitions } from "./languages/LanguageDefinitions";
+import { TalonSpokenFormsJsonReader } from "./nodeCommon/TalonSpokenFormsJsonReader";
 import { ModifierStageFactoryImpl } from "./processTargets/ModifierStageFactoryImpl";
 import { ScopeHandlerFactoryImpl } from "./processTargets/modifiers/scopeHandlers";
 import { runCommand } from "./runCommand";
@@ -28,15 +29,16 @@ import { ScopeRangeProvider } from "./scopeProviders/ScopeRangeProvider";
 import { ScopeRangeWatcher } from "./scopeProviders/ScopeRangeWatcher";
 import { ScopeSupportChecker } from "./scopeProviders/ScopeSupportChecker";
 import { ScopeSupportWatcher } from "./scopeProviders/ScopeSupportWatcher";
-import { TalonSpokenFormsJsonReader } from "./nodeCommon/TalonSpokenFormsJsonReader";
 import { injectIde } from "./singletons/ide.singleton";
+import { TreeSitter } from "./typings/TreeSitter";
 
 export function createCursorlessEngine(
   treeSitter: TreeSitter,
   ide: IDE,
   hats: Hats,
   commandServerApi: CommandServerApi | null,
   fileSystem: FileSystem,
+  commandHistory: CommandHistory,
 ): CursorlessEngine {
   injectIde(ide);
 
@@ -81,6 +83,7 @@ export function createCursorlessEngine(
           languageDefinitions,
           rangeUpdater,
           commandRunnerDecorators,
+          commandHistory,
           command,
         );
       },
@@ -95,6 +98,7 @@ export function createCursorlessEngine(
           languageDefinitions,
           rangeUpdater,
           commandRunnerDecorators,
+          commandHistory,
           ensureCommandShape(args),
         );
       },

packages/cursorless-engine/src/runCommand.ts

@@ -1,6 +1,12 @@
-import { Command, HatTokenMap, ReadOnlyHatMap } from "@cursorless/common";
+import {
+  Command,
+  CommandHistory,
+  HatTokenMap,
+  ReadOnlyHatMap,
+} from "@cursorless/common";
 import { CommandRunner } from "./CommandRunner";
 import { Actions } from "./actions/Actions";
+import { CommandRunnerDecorator } from "./api/CursorlessEngineApi";
 import { Debug } from "./core/Debug";
 import { Snippets } from "./core/Snippets";
 import { CommandRunnerImpl } from "./core/commandRunner/CommandRunnerImpl";
@@ -12,7 +18,6 @@ import { TargetPipelineRunner } from "./processTargets";
 import { MarkStageFactoryImpl } from "./processTargets/MarkStageFactoryImpl";
 import { ModifierStageFactoryImpl } from "./processTargets/ModifierStageFactoryImpl";
 import { ScopeHandlerFactoryImpl } from "./processTargets/modifiers/scopeHandlers";
-import { CommandRunnerDecorator } from "./api/CursorlessEngineApi";
 
 /**
  * Entry point for Cursorless commands. We proceed as follows:
@@ -35,6 +40,7 @@ export async function runCommand(
   languageDefinitions: LanguageDefinitions,
   rangeUpdater: RangeUpdater,
   commandRunnerDecorators: CommandRunnerDecorator[],
+  commandHistory: CommandHistory,
   command: Command,
 ): Promise<unknown> {
   if (debug.active) {
@@ -44,6 +50,8 @@ export async function runCommand(
 
   const commandComplete = canonicalizeAndValidateCommand(command);
 
+  void commandHistory.append(commandComplete);
+
   const readableHatMap = await hatTokenMap.getReadableMap(
     commandComplete.usePrePhraseSnapshot,
   );

packages/cursorless-vscode/src/extension.ts

@@ -12,6 +12,7 @@ import {
 } from "@cursorless/common";
 import {
   createCursorlessEngine,
+  TestCaseRecorder,
   TreeSitter,
 } from "@cursorless/cursorless-engine";
 import {
@@ -22,13 +23,18 @@ import {
   toVscodeRange,
 } from "@cursorless/vscode-common";
 import * as crypto from "crypto";
+import { mkdir } from "fs/promises";
 import * as os from "os";
 import * as path from "path";
 import * as vscode from "vscode";
 import { constructTestHelpers } from "./constructTestHelpers";
 import { FakeFontMeasurements } from "./ide/vscode/hats/FakeFontMeasurements";
 import { FontMeasurementsImpl } from "./ide/vscode/hats/FontMeasurementsImpl";
 import { VscodeHats } from "./ide/vscode/hats/VscodeHats";
+import {
+  DisabledCommandHistory,
+  VscodeCommandHistory,
+} from "./ide/vscode/VscodeCommandHistory";
 import { VscodeFileSystem } from "./ide/vscode/VscodeFileSystem";
 import { VscodeIDE } from "./ide/vscode/VscodeIDE";
 import {
@@ -47,8 +53,6 @@ import {
 } from "./ScopeVisualizerCommandApi";
 import { StatusBarItem } from "./StatusBarItem";
 import { vscodeApi } from "./vscodeApi";
-import { mkdir } from "fs/promises";
-import { TestCaseRecorder } from "@cursorless/cursorless-engine";
 
 /**
  * Extension entrypoint called by VSCode on Cursorless startup.
@@ -81,6 +85,13 @@ export async function activate(
 
   const treeSitter: TreeSitter = createTreeSitter(parseTreeApi);
 
+  const commandHistory =
+    vscodeIDE.runMode === "test"
+      ? DisabledCommandHistory
+      : new VscodeCommandHistory(vscodeIDE, fileSystem);
+
+  context.subscriptions.push(commandHistory);
+
   const {
     commandApi,
     storedTargets,
@@ -97,6 +108,7 @@ export async function activate(
     hats,
     commandServerApi,
     fileSystem,
+    commandHistory,
   );
 
   const testCaseRecorder = new TestCaseRecorder(hatTokenMap, storedTargets);

packages/cursorless-vscode/src/ide/vscode/VscodeCommandHistory.ts

@@ -0,0 +1,94 @@
+import {
+  CommandComplete,
+  CommandHistory,
+  CommandHistoryItem,
+  Disposable,
+  FileSystem,
+} from "@cursorless/common";
+import * as fs from "fs/promises";
+import { mkdirSync } from "fs";
+import * as path from "path";
+import * as vscode from "vscode";
+import { VscodeIDE } from "./VscodeIDE";
+
+const dirName = "commandHistory";
+const filePrefix = "cursorlessCommandHistory";
+const settingSection = "cursorless";
+const settingName = "commandHistory";
+const settingFullName = `${settingSection}.${settingName}`;
+
+export class VscodeCommandHistory implements CommandHistory {
+  private readonly dirPath: string;
+  private readonly cursorlessVersion: string;
+  private disposable: Disposable;
+  private active: boolean = false;
+
+  constructor(ide: VscodeIDE, fileSystem: FileSystem) {
+    this.evaluateSetting = this.evaluateSetting.bind(this);
+    this.cursorlessVersion = ide.cursorlessVersion;
+    this.dirPath = path.join(fileSystem.cursorlessDir, dirName);
+
+    mkdirSync(this.dirPath, { recursive: true });
+
+    this.evaluateSetting();
+
+    this.disposable = vscode.workspace.onDidChangeConfiguration((event) => {
+      if (event.affectsConfiguration(settingFullName)) {
+        this.evaluateSetting();
+      }
+    });
+  }
+
+  async append(command: CommandComplete): Promise<void> {
+    if (!this.active) {
+      return;
+    }
+
+    const date = new Date();
+    const fileName = `${filePrefix}_${getMonthDate(date)}.jsonl`;
+    const file = path.join(this.dirPath, fileName);
+
+    const historyItem: CommandHistoryItem = {
+      date: getDayDate(date),
+      cursorlessVersion: this.cursorlessVersion,
+      command: sanitizeCommand(command),
+    };
+    const data = JSON.stringify(historyItem) + "\n";
+
+    await fs.appendFile(file, data, "utf8");
+  }
+
+  private evaluateSetting() {
+    this.active =
+      vscode.workspace
+        .getConfiguration(settingSection)
+        .get<boolean>(settingName) ?? false;
+  }
+
+  dispose() {
+    this.disposable.dispose();
+  }
+}
+
+export const DisabledCommandHistory: CommandHistory = {
+  async append(command: CommandComplete) {},
+  dispose() {},
+};
+
+function sanitizeCommand(command: CommandComplete): CommandComplete {
+  // TODO: Sanitize action payload
+  const { spokenForm, ...rest } = command;
+  return rest;
+}
+
+function getMonthDate(date: Date): string {
+  return `${date.getFullYear()}-${pad(date.getMonth() + 1)}`;
+}
+
+function getDayDate(date: Date): string {
+  return `${getMonthDate(date)}-${pad(date.getDate())}`;
+}
+
+function pad(num: number): string {
+  return num.toString().padStart(2, "0");
+}

packages/cursorless-vscode/src/ide/vscode/VscodeIDE.ts

@@ -40,6 +40,7 @@ export class VscodeIDE implements IDE {
   readonly messages: VscodeMessages;
   readonly clipboard: VscodeClipboard;
   readonly capabilities: VscodeCapabilities;
+  readonly cursorlessVersion: string;
   private flashHandler: VscodeFlashHandler;
   private highlights: VscodeHighlights;
   private editorMap;
@@ -53,6 +54,7 @@ export class VscodeIDE implements IDE {
     this.flashHandler = new VscodeFlashHandler(this, this.highlights);
     this.capabilities = new VscodeCapabilities();
     this.editorMap = new WeakMap<vscode.TextEditor, VscodeTextEditorImpl>();
+    this.cursorlessVersion = extensionContext.extension.packageJSON.version;
   }
 
   async showQuickPick(