Added playground action (#1894)

Fixes #1893

`"parse tree class"`


![image](https://github.com/cursorless-dev/cursorless/assets/3511326/d5dfcae1-10a2-46bf-8f42-f75a680ddd63)


## Checklist

- [x] I have added
[tests](https://www.cursorless.org/docs/contributing/test-case-recorder/)
- [/] I have updated the
[docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and
[cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet)
- [/] I have not broken the cheatsheet

---------

Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>

Author: AndreasArvidsson

cursorless-talon-dev/src/cursorless_dev.talon

@@ -1,3 +1,5 @@
+mode: command
+mode: user.cursorless_spoken_form_test
 tag: user.cursorless
 -
 
@@ -28,3 +30,6 @@ tag: user.cursorless
 
 test snippet make <user.cursorless_target>:
     user.private_cursorless_make_snippet_test(cursorless_target)
+
+parse tree <user.cursorless_target>:
+    user.cursorless_command("private.showParseTree", cursorless_target)

packages/common/src/ide/PassthroughIDEBase.ts

@@ -10,7 +10,13 @@ import {
   TextEditorVisibleRangesChangeEvent,
 } from "./types/events.types";
 import { FlashDescriptor } from "./types/FlashDescriptor";
-import { Disposable, IDE, RunMode, WorkspaceFolder } from "./types/ide.types";
+import {
+  Disposable,
+  IDE,
+  OpenUntitledTextDocumentOptions,
+  RunMode,
+  WorkspaceFolder,
+} from "./types/ide.types";
 import { Messages } from "./types/Messages";
 import { QuickPickOptions } from "./types/QuickPickOptions";
 import { State } from "./types/State";
@@ -137,6 +143,12 @@ export default class PassthroughIDEBase implements IDE {
     return this.original.openTextDocument(path);
   }
 
+  public openUntitledTextDocument(
+    options?: OpenUntitledTextDocumentOptions,
+  ): Promise<TextEditor> {
+    return this.original.openUntitledTextDocument(options);
+  }
+
   public showQuickPick(
     items: readonly string[],
     options?: QuickPickOptions,

packages/common/src/ide/fake/FakeIDE.ts

@@ -1,21 +1,22 @@
-import type { EditableTextEditor, TextEditor } from "../..";
 import { pull } from "lodash";
+import type { EditableTextEditor, TextEditor } from "../..";
 import { GeneralizedRange } from "../../types/GeneralizedRange";
 import { TextDocument } from "../../types/TextDocument";
 import type { TextDocumentChangeEvent } from "../types/Events";
+import { FlashDescriptor } from "../types/FlashDescriptor";
+import { QuickPickOptions } from "../types/QuickPickOptions";
 import {
   Event,
   TextEditorSelectionChangeEvent,
   TextEditorVisibleRangesChangeEvent,
 } from "../types/events.types";
-import { FlashDescriptor } from "../types/FlashDescriptor";
 import type {
   Disposable,
   IDE,
+  OpenUntitledTextDocumentOptions,
   RunMode,
   WorkspaceFolder,
 } from "../types/ide.types";
-import { QuickPickOptions } from "../types/QuickPickOptions";
 import { FakeCapabilities } from "./FakeCapabilities";
 import FakeClipboard from "./FakeClipboard";
 import FakeConfiguration from "./FakeConfiguration";
@@ -92,6 +93,12 @@ export default class FakeIDE implements IDE {
     throw Error("Not implemented");
   }
 
+  public openUntitledTextDocument(
+    _options: OpenUntitledTextDocumentOptions,
+  ): Promise<TextEditor> {
+    throw Error("Not implemented");
+  }
+
   public setQuickPickReturnValue(value: string | undefined) {
     this.quickPickReturnValue = value;
   }

packages/common/src/ide/types/ide.types.ts

@@ -22,6 +22,10 @@ import { State } from "./State";
 
 export type RunMode = "production" | "development" | "test";
 export type HighlightId = string;
+export interface OpenUntitledTextDocumentOptions {
+  language?: string;
+  content?: string;
+}
 
 export interface IDE {
   readonly configuration: Configuration;
@@ -105,6 +109,17 @@ export interface IDE {
    */
   openTextDocument(path: string): Promise<TextEditor>;
 
+  /**
+   * Opens an untitled document.
+   *
+   * @see {@link openTextDocument}
+   * @param options optional language and documents content
+   * @return An editor
+   */
+  openUntitledTextDocument(
+    options?: OpenUntitledTextDocumentOptions,
+  ): Promise<TextEditor>;
+
   /**
    * An event that is emitted when a {@link TextDocument text document} is opened or when the language id
    * of a text document {@link languages.setTextDocumentLanguage has been changed}.

packages/common/src/types/command/ActionDescriptor.ts

@@ -46,6 +46,7 @@ const simpleActionNames = [
   "toggleLineBreakpoint",
   "toggleLineComment",
   "unfoldRegion",
+  "private.showParseTree",
   "private.getTargets",
 ] as const;
 

packages/cursorless-engine/src/actions/Actions.ts

@@ -1,3 +1,4 @@
+import { TreeSitter } from "..";
 import { Snippets } from "../core/Snippets";
 import { RangeUpdater } from "../core/updateSelections/RangeUpdater";
 import { ModifierStageFactory } from "../processTargets/ModifierStageFactory";
@@ -26,6 +27,7 @@ import {
 } from "./InsertEmptyLines";
 import InsertSnippet from "./InsertSnippet";
 import { PasteFromClipboard } from "./PasteFromClipboard";
+import ShowParseTree from "./ShowParseTree";
 import Remove from "./Remove";
 import Replace from "./Replace";
 import Rewrap from "./Rewrap";
@@ -63,6 +65,7 @@ import { ActionRecord } from "./actions.types";
  */
 export class Actions implements ActionRecord {
   constructor(
+    private treeSitter: TreeSitter,
     private snippets: Snippets,
     private rangeUpdater: RangeUpdater,
     private modifierStageFactory: ModifierStageFactory,
@@ -145,5 +148,6 @@ export class Actions implements ActionRecord {
     this.snippets,
     this.modifierStageFactory,
   );
+  ["private.showParseTree"] = new ShowParseTree(this.treeSitter);
   ["private.getTargets"] = new GetTargets();
 }

packages/cursorless-engine/src/actions/ShowParseTree.ts

@@ -0,0 +1,121 @@
+import { FlashStyle, Range, TextDocument } from "@cursorless/common";
+import * as path from "node:path";
+import type { Tree, TreeCursor } from "web-tree-sitter";
+import type { TreeSitter } from "..";
+import { ide } from "../singletons/ide.singleton";
+import type { Target } from "../typings/target.types";
+import { flashTargets } from "../util/targetUtils";
+import type { ActionReturnValue } from "./actions.types";
+
+export default class ShowParseTree {
+  constructor(private treeSitter: TreeSitter) {
+    this.run = this.run.bind(this);
+  }
+
+  async run(targets: Target[]): Promise<ActionReturnValue> {
+    await flashTargets(ide(), targets, FlashStyle.referenced);
+
+    const results: string[] = ["# Cursorless parse tree"];
+
+    for (const target of targets) {
+      const { editor, contentRange } = target;
+      const tree = this.treeSitter.getTree(editor.document);
+      results.push(parseTree(editor.document, tree, contentRange));
+    }
+
+    ide().openUntitledTextDocument({
+      language: "markdown",
+      content: results.join("\n\n"),
+    });
+
+    return { thatTargets: targets };
+  }
+}
+
+function parseTree(
+  document: TextDocument,
+  tree: Tree,
+  contentRange: Range,
+): string {
+  const resultPlayground: string[] = [];
+  const resultQuery: string[] = [];
+
+  parseCursor(resultPlayground, resultQuery, contentRange, tree.walk(), 0);
+
+  return [
+    `## ${path.basename(document.uri.path)} [${contentRange}]\n`,
+    `\`\`\`${document.languageId}`,
+    document.getText(contentRange),
+    "```",
+    "",
+    "```scm",
+    ...resultQuery,
+    "```",
+    "",
+    "```js",
+    ...resultPlayground,
+    "```",
+    "",
+  ].join("\n");
+}
+
+function parseCursor(
+  resultPlayground: string[],
+  resultQuery: string[],
+  contentRange: Range,
+  cursor: TreeCursor,
+  numIndents: number,
+): void {
+  while (true) {
+    const nodeRange = new Range(
+      cursor.startPosition.row,
+      cursor.startPosition.column,
+      cursor.endPosition.row,
+      cursor.endPosition.column,
+    );
+
+    if (contentRange.intersection(nodeRange) != null) {
+      const indentation = "  ".repeat(numIndents);
+      const fieldName = getFieldName(cursor);
+      const prefix = indentation + fieldName;
+
+      // Named node
+      if (cursor.nodeIsNamed) {
+        resultPlayground.push(`${prefix}${cursor.nodeType} [${nodeRange}]`);
+        resultQuery.push(`${prefix}(${cursor.nodeType}`);
+
+        // Named node with children
+        if (cursor.gotoFirstChild()) {
+          parseCursor(
+            resultPlayground,
+            resultQuery,
+            contentRange,
+            cursor,
+            numIndents + 1,
+          );
+          cursor.gotoParent();
+          resultQuery.push(`${indentation})`);
+        }
+        // Named node without children
+        else {
+          resultQuery[resultQuery.length - 1] += ")";
+        }
+      }
+      // Anonymous node
+      else {
+        const type = `"${cursor.nodeType}"`;
+        resultPlayground.push(`${prefix}${type} [${nodeRange}]`);
+        resultQuery.push(`${prefix}${type}`);
+      }
+    }
+
+    if (!cursor.gotoNextSibling()) {
+      return;
+    }
+  }
+}
+
+function getFieldName(cursor: TreeCursor): string {
+  const field = cursor.currentFieldName();
+  return field != null ? `${field}: ` : "";
+}

packages/cursorless-engine/src/cursorlessEngine.ts

@@ -59,6 +59,7 @@ export function createCursorlessEngine(
     commandApi: {
       runCommand(command: Command) {
         return runCommand(
+          treeSitter,
           debug,
           hatTokenMap,
           testCaseRecorder,
@@ -72,6 +73,7 @@ export function createCursorlessEngine(
 
       runCommandSafe(...args: unknown[]) {
         return runCommand(
+          treeSitter,
           debug,
           hatTokenMap,
           testCaseRecorder,

packages/cursorless-engine/src/generateSpokenForm/defaultSpokenForms/actions.ts

@@ -54,6 +54,7 @@ export const actions = {
   insertSnippet: "snippet",
   pasteFromClipboard: "paste",
 
+  ["private.showParseTree"]: "parse tree",
   ["experimental.setInstanceReference"]: "from",
 
   editNew: null,

packages/cursorless-engine/src/runCommand.ts

@@ -6,7 +6,7 @@ import { Snippets } from "./core/Snippets";
 import { CommandRunnerImpl } from "./core/commandRunner/CommandRunnerImpl";
 import { canonicalizeAndValidateCommand } from "./core/commandVersionUpgrades/canonicalizeAndValidateCommand";
 import { RangeUpdater } from "./core/updateSelections/RangeUpdater";
-import { StoredTargetMap, TestCaseRecorder } from "./index";
+import { StoredTargetMap, TestCaseRecorder, TreeSitter } from "./index";
 import { LanguageDefinitions } from "./languages/LanguageDefinitions";
 import { TargetPipelineRunner } from "./processTargets";
 import { MarkStageFactoryImpl } from "./processTargets/MarkStageFactoryImpl";
@@ -26,6 +26,7 @@ import { ScopeHandlerFactoryImpl } from "./processTargets/modifiers/scopeHandler
  * 5. Call {@link CommandRunnerImpl.run} to run the actual command.
  */
 export async function runCommand(
+  treeSitter: TreeSitter,
   debug: Debug,
   hatTokenMap: HatTokenMap,
   testCaseRecorder: TestCaseRecorder,
@@ -47,6 +48,7 @@ export async function runCommand(
   );
 
   let commandRunner = createCommandRunner(
+    treeSitter,
     languageDefinitions,
     debug,
     storedTargets,
@@ -66,6 +68,7 @@ export async function runCommand(
 }
 
 function createCommandRunner(
+  treeSitter: TreeSitter,
   languageDefinitions: LanguageDefinitions,
   debug: Debug,
   storedTargets: StoredTargetMap,
@@ -92,6 +95,6 @@ function createCommandRunner(
     debug,
     storedTargets,
     targetPipelineRunner,
-    new Actions(snippets, rangeUpdater, modifierStageFactory),
+    new Actions(treeSitter, snippets, rangeUpdater, modifierStageFactory),
   );
 }