Cursorless tutorial ced

cursorless-talon/src/get_action_spoken_form.py

@@ -0,0 +1,30 @@
+from talon import registry
+
+from .actions.actions import ACTION_LIST_NAMES
+from .conventions import get_cursorless_list_name
+
+
+def make_cursorless_list_reverse_look_up(*raw_list_names: str):
+    return make_list_reverse_look_up(
+        *[get_cursorless_list_name(raw_list_name) for raw_list_name in raw_list_names]
+    )
+
+
+def make_list_reverse_look_up(*list_names: str):
+    """
+    Given a list of talon list names, returns a function that does a reverse
+    look-up in all lists to find the spoken form for its input.
+    """
+
+    def return_func(argument: str):
+        for list_name in list_names:
+            for spoken_form, value in registry.lists[list_name][-1].items():
+                if value == argument:
+                    return list_name, spoken_form
+
+        raise LookupError(f"Unknown identifier `{argument}`")
+
+    return return_func
+
+
+lookup_action = make_cursorless_list_reverse_look_up(*ACTION_LIST_NAMES)

cursorless-talon/src/tutorial.py

@@ -0,0 +1,98 @@
+import json
+import re
+from pathlib import Path
+from typing import Callable
+
+import yaml
+from talon import actions, app
+
+from .get_action_spoken_form import lookup_action
+
+regex = re.compile(r"\{(\w+):([^}]+)\}")
+tutorial_dir = Path(
+    r"C:\work\tools\voicecoding\cursorless_fork\packages\cursorless-vscode-e2e\src\suite\fixtures\recorded\tutorial\unit-2-basic-coding"
+)
+
+
+def process_literal_step(argument: str):
+    return f"<cmd@{argument}/>"
+
+
+def process_action(argument: str):
+    _, spoken_form = lookup_action(argument)
+    return f'<*"{spoken_form}"/>'
+
+
+def process_scope_type(argument: str):
+    # TODO not sure what we are trying to achieve here
+    _, spoken_form = lookup_scope_type(argument)
+    return f'<*"{spoken_form}"/>'
+
+
+def process_cursorless_command_step(argument: str):
+    print(f"{argument=}")
+    step_fixture = yaml.safe_load((tutorial_dir / argument).read_text())
+    print(f"{step_fixture['command']=}")
+    result = actions.user.private_cursorless_run_rpc_command_get(
+        "cursorless.tutorial.create",
+        {
+            "version": 0,
+            "stepFixture": step_fixture,
+            "yamlFilename": argument,
+        },
+    )
+    print(f"{result=}")
+    return f"<cmd@{cursorless_command_to_spoken_form(step_fixture['command'])}/>"
+    # return f"<cmd@{result}/>"
+
+
+# TODO get this information from the extension
+def cursorless_command_to_spoken_form(command: dict[str, str]):
+    return command["spokenForm"]
+
+
+interpolation_processor_map: dict[str, Callable[[str], str]] = {
+    "literalStep": process_literal_step,
+    "action": process_action,
+    "scopeType": process_scope_type,
+    "step": process_cursorless_command_step,
+}
+
+
+def process_tutorial_step(raw: str):
+    print(f"{raw=}")
+    current_index = 0
+    content = ""
+    for match in regex.finditer(raw):
+        content += raw[current_index : match.start()]
+        content += interpolation_processor_map[match.group(1)](match.group(2))
+        current_index = match.end()
+    content += raw[current_index : len(raw)]
+    print(f"{content=}")
+
+    return {
+        "content": content,
+        "restore_callback": print,
+        "modes": ["command"],
+        "app": "Code",
+        "context_hint": "Please open VSCode and enter command mode",
+    }
+
+
+def get_basic_coding_walkthrough():
+    with open(tutorial_dir / "script.json") as f:
+        script = json.load(f)
+
+    return [
+        actions.user.hud_create_walkthrough_step(**process_tutorial_step(step))
+        for step in script
+    ]
+
+
+def on_ready():
+    actions.user.hud_add_lazy_walkthrough(
+        "Cursorless basic coding", get_basic_coding_walkthrough
+    )
+
+
+app.register("ready", on_ready)

data/playground/tutorial/extra-cloning-a-talon-list.py

@@ -0,0 +1,9 @@
+from talon import Context, Module
+
+mod = Module()
+ctx = Context()
+
+mod.list("cursorless_walkthrough_list", desc="My tutorial list")
+ctx.list["user.cursorless_walkthrough_list"] = {
+    "spoken form": "whatever",
+}

data/playground/tutorial/unit-1-basics.txt

@@ -0,0 +1,11 @@
+==================================================
+==========                              ==========
+==========    Welcome to Cursorless!    ==========
+==========                              ==========
+==========   Let's start using marks    ==========
+==========                              ==========
+==========  so we can navigate around   ==========
+==========                              ==========
+==========  without lifting a finger!   ==========
+==========                              ==========
+==================================================

data/playground/tutorial/unit-2-basic-coding.py

@@ -0,0 +1,13 @@
+def print_color(color, invert=False):
+    if invert:
+        print(invert_color(color))
+    else:
+        print(color)
+
+
+def invert_color(color):
+    if color == "black":
+        return "white"
+
+
+print_color("black")

packages/cursorless-engine/package.json

@@ -17,6 +17,7 @@
   "license": "MIT",
   "dependencies": {
     "@cursorless/common": "workspace:*",
+    "@cursorless/vscode-common": "workspace:*",
     "immer": "^9.0.15",
     "immutability-helper": "^3.1.1",
     "itertools": "^2.1.1",

packages/cursorless-engine/src/core/Tutorial.ts

@@ -0,0 +1,65 @@
+// import { readFile, writeFile } from "fs/promises";
+// import { parse } from "node-html-parser";
+// import produce from "immer";
+// import { sortBy } from "lodash";
+// import { ide } from "../singletons/ide.singleton";
+import path from "path";
+// import { getCursorlessRepoRoot } from "@cursorless/common";
+
+// TODO the engine is editor agnostic so we shouldn't really import that
+// TODO Editor specific features are accessed via the injected ide instance.
+// TODO packages\cursorless-engine\src\singletons\ide.singleton.ts
+import { openNewEditor } from "@cursorless/vscode-common";
+
+import * as yaml from "js-yaml";
+import { promises as fsp } from "node:fs";
+
+import { TestCaseFixture } from "@cursorless/common";
+import { Dictionary } from "lodash";
+
+const tutorial_dir =
+  "C:\\work\\tools\\voicecoding\\cursorless_fork\\packages\\cursorless-vscode-e2e\\src\\suite\\fixtures\\recorded\\tutorial\\unit-2-basic-coding";
+
+/**
+ * The argument expected by the tutorial command.
+ */
+interface TutorialCommandArg {
+  /**
+   * The version of the tutorial command.
+   */
+  version: 0;
+
+  /**
+   * A representation of the yaml file
+   */
+  stepFixture: Dictionary<string>;
+
+  /**
+   * The yaml file for the current step
+   */
+  yamlFilename: string;
+}
+
+export async function tutorialCreate({
+  version,
+  stepFixture,
+  yamlFilename,
+}: TutorialCommandArg) {
+  if (version !== 0) {
+    throw new Error(`Unsupported tutorial api version: ${version}`);
+  }
+
+  // const fixture = stepFixture as TestCaseFixture;
+  createEnvironment(yamlFilename);
+  // TODO need to answer to the talon side only what is necessary
+  return stepFixture;
+}
+
+async function createEnvironment(yamlFilename: string) {
+  const buffer = await fsp.readFile(path.join(tutorial_dir, yamlFilename));
+  const fixture = yaml.load(buffer.toString()) as TestCaseFixture;
+
+  const editor = await openNewEditor(fixture.initialState.documentContents, {
+    languageId: fixture.languageId,
+  });
+}

packages/cursorless-engine/src/index.ts

@@ -1,5 +1,6 @@
 export * from "./testUtil/plainObjectToTarget";
 export * from "./core/Cheatsheet";
+export * from "./core/Tutorial";
 export * from "./testUtil/takeSnapshot";
 export * from "./testCaseRecorder/TestCaseRecorder";
 export * from "./core/StoredTargets";

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/tutorial/extra-cloning-a-talon-list/bringBlockMade.yml

@@ -0,0 +1,52 @@
+languageId: python
+command:
+  version: 6
+  spokenForm: bring block made
+  action:
+    name: replaceWithTarget
+    source:
+      type: primitive
+      modifiers:
+        - type: containingScope
+          scopeType: {type: paragraph}
+      mark: {type: decoratedSymbol, symbolColor: default, character: m}
+    destination: {type: implicit}
+  usePrePhraseSnapshot: false
+initialState:
+  documentContents: |+
+    from talon import Context, Module
+
+    mod = Module()
+    ctx = Context()
+
+    mod.list("cursorless_walkthrough_list", desc="My tutorial list")
+    ctx.list['user.cursorless_walkthrough_list'] = {
+        "spoken form": "whatever",
+    }
+
+  selections:
+    - anchor: {line: 10, character: 0}
+      active: {line: 10, character: 0}
+  marks:
+    default.m:
+      start: {line: 5, character: 0}
+      end: {line: 5, character: 3}
+finalState:
+  documentContents: |-
+    from talon import Context, Module
+
+    mod = Module()
+    ctx = Context()
+
+    mod.list("cursorless_walkthrough_list", desc="My tutorial list")
+    ctx.list['user.cursorless_walkthrough_list'] = {
+        "spoken form": "whatever",
+    }
+
+    mod.list("cursorless_walkthrough_list", desc="My tutorial list")
+    ctx.list['user.cursorless_walkthrough_list'] = {
+        "spoken form": "whatever",
+    }
+  selections:
+    - anchor: {line: 13, character: 1}
+      active: {line: 13, character: 1}

packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/tutorial/extra-cloning-a-talon-list/clearCoreSun.yml

@@ -0,0 +1,56 @@
+languageId: python
+command:
+  version: 6
+  spokenForm: change inside pair sun
+  action:
+    name: clearAndSetSelection
+    target:
+      type: primitive
+      modifiers:
+        - {type: interiorOnly}
+        - type: containingScope
+          scopeType: {type: surroundingPair, delimiter: any}
+      mark: {type: decoratedSymbol, symbolColor: default, character: s}
+  usePrePhraseSnapshot: false
+initialState:
+  documentContents: |-
+    from talon import Context, Module
+
+    mod = Module()
+    ctx = Context()
+
+    mod.list("cursorless_walkthrough_list", desc="My tutorial list")
+    ctx.list['user.cursorless_walkthrough_list'] = {
+        "spoken form": "whatever",
+    }
+
+    mod.list("emoji", desc="Emojis")
+    ctx.list['user.emoji'] = {
+        "spoken form": "whatever",
+    }
+  selections:
+    - anchor: {line: 10, character: 30}
+      active: {line: 10, character: 30}
+  marks:
+    default.s:
+      start: {line: 12, character: 5}
+      end: {line: 12, character: 11}
+finalState:
+  documentContents: |-
+    from talon import Context, Module
+
+    mod = Module()
+    ctx = Context()
+
+    mod.list("cursorless_walkthrough_list", desc="My tutorial list")
+    ctx.list['user.cursorless_walkthrough_list'] = {
+        "spoken form": "whatever",
+    }
+
+    mod.list("emoji", desc="Emojis")
+    ctx.list['user.emoji'] = {
+        "": "whatever",
+    }
+  selections:
+    - anchor: {line: 12, character: 5}
+      active: {line: 12, character: 5}