Skip to content

Commit afee306

Browse files
pokeypokey
committed
Cursorless tutorial
1 parent b9590b4 commit afee306

76 files changed

Lines changed: 3190 additions & 12 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.vscode/tasks.json‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,16 @@
3232
},
3333
"group": "build"
3434
},
35+
{
36+
"label": "Build tutorial webview",
37+
"type": "npm",
38+
"script": "build:dev",
39+
"path": "packages/cursorless-vscode-tutorial-webview",
40+
"presentation": {
41+
"reveal": "silent"
42+
},
43+
"group": "build"
44+
},
3545
{
3646
"label": "Build test harness",
3747
"type": "npm",
@@ -57,6 +67,7 @@
5767
"type": "npm",
5868
"script": "populate-dist",
5969
"path": "packages/cursorless-vscode",
70+
"dependsOn": ["Build tutorial webview"],
6071
"presentation": {
6172
"reveal": "silent"
6273
},
@@ -103,6 +114,17 @@
103114
"dependsOn": ["Watch esbuild", "Watch typescript"],
104115
"group": "build"
105116
},
117+
{
118+
"label": "watch tutorial",
119+
"type": "npm",
120+
"script": "watch:tailwind",
121+
"isBackground": true,
122+
"presentation": {
123+
"reveal": "never"
124+
},
125+
"path": "packages/cursorless-vscode-tutorial-webview",
126+
"group": "build"
127+
},
106128
{
107129
"type": "npm",
108130
"script": "watch:esbuild",

‎cursorless-talon/src/cheatsheet/cheat_sheet.py‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
from .sections.modifiers import get_modifiers
1212
from .sections.scopes import get_scopes
1313
from .sections.special_marks import get_special_marks
14+
from .sections.tutorial import get_tutorial_entries
1415

1516
mod = Module()
1617
ctx = Context()
@@ -37,6 +38,7 @@ def private_cursorless_cheat_sheet_update_json():
3738

3839
def private_cursorless_open_instructions():
3940
"""Open web page with cursorless instructions"""
41+
actions.user.private_cursorless_notify_docs_opened()
4042
webbrowser.open(instructions_url)
4143

4244

@@ -150,5 +152,10 @@ def cursorless_cheat_sheet_get_json():
150152
"id": "shapes",
151153
"items": get_list("hat_shape", "hatShape"),
152154
},
155+
{
156+
"name": "Tutorial",
157+
"id": "tutorial",
158+
"items": get_tutorial_entries(),
159+
},
153160
]
154161
}

‎cursorless-talon/src/cheatsheet/sections/tutorial.py‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
def get_tutorial_entries():
2+
return [
3+
{
4+
"id": "start_tutorial",
5+
"type": "command",
6+
"variations": [
7+
{
8+
"spokenForm": "cursorless tutorial",
9+
"description": "Start the introductory Cursorless tutorial",
10+
},
11+
],
12+
},
13+
{
14+
"id": "tutorial_next",
15+
"type": "command",
16+
"variations": [
17+
{
18+
"spokenForm": "tutorial next",
19+
"description": "Advance to next step in tutorial",
20+
},
21+
],
22+
},
23+
{
24+
"id": "tutorial_previous",
25+
"type": "command",
26+
"variations": [
27+
{
28+
"spokenForm": "tutorial previous",
29+
"description": "Go back to previous step in tutorial",
30+
},
31+
],
32+
},
33+
{
34+
"id": "tutorial_restart",
35+
"type": "command",
36+
"variations": [
37+
{
38+
"spokenForm": "tutorial restart",
39+
"description": "Restart the tutorial",
40+
},
41+
],
42+
},
43+
{
44+
"id": "tutorial_resume",
45+
"type": "command",
46+
"variations": [
47+
{
48+
"spokenForm": "tutorial resume",
49+
"description": "Resume the tutorial",
50+
},
51+
],
52+
},
53+
{
54+
"id": "tutorial_list",
55+
"type": "command",
56+
"variations": [
57+
{
58+
"spokenForm": "tutorial list",
59+
"description": "List all available tutorials",
60+
},
61+
],
62+
},
63+
{
64+
"id": "tutorial_close",
65+
"type": "command",
66+
"variations": [
67+
{
68+
"spokenForm": "tutorial close",
69+
"description": "Close the tutorial",
70+
},
71+
],
72+
},
73+
{
74+
"id": "tutorial_start_by_number",
75+
"type": "command",
76+
"variations": [
77+
{
78+
"spokenForm": "tutorial <number>",
79+
"description": "Start a specific tutorial by number",
80+
},
81+
],
82+
},
83+
]

‎cursorless-talon/src/cursorless.py‎

Lines changed: 67 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
from talon import Module, actions
1+
from talon import Context, Module, actions
22

33
mod = Module()
44

@@ -7,6 +7,13 @@
77
"Application supporting cursorless commands",
88
)
99

10+
global_ctx = Context()
11+
12+
cursorless_ctx = Context()
13+
cursorless_ctx.matches = r"""
14+
tag: user.cursorless
15+
"""
16+
1017

1118
@mod.action_class
1219
class Actions:
@@ -16,8 +23,67 @@ def private_cursorless_show_settings_in_ide():
1623
def private_cursorless_show_sidebar():
1724
"""Show Cursorless-specific settings in ide"""
1825

26+
def private_cursorless_notify_docs_opened():
27+
"""Notify the ide that the docs were opened in case the tutorial is waiting for that event"""
28+
...
29+
1930
def private_cursorless_show_command_statistics():
2031
"""Show Cursorless command statistics"""
2132
actions.user.private_cursorless_run_rpc_command_no_wait(
2233
"cursorless.analyzeCommandHistory"
2334
)
35+
36+
def private_cursorless_start_tutorial():
37+
"""Start the introductory Cursorless tutorial"""
38+
actions.user.private_cursorless_run_rpc_command_no_wait(
39+
"cursorless.tutorial.start", "unit-1-basics"
40+
)
41+
42+
def private_cursorless_tutorial_next():
43+
"""Cursorless tutorial: next"""
44+
actions.user.private_cursorless_run_rpc_command_no_wait(
45+
"cursorless.tutorial.next"
46+
)
47+
48+
def private_cursorless_tutorial_previous():
49+
"""Cursorless tutorial: previous"""
50+
actions.user.private_cursorless_run_rpc_command_no_wait(
51+
"cursorless.tutorial.previous"
52+
)
53+
54+
def private_cursorless_tutorial_restart():
55+
"""Cursorless tutorial: restart"""
56+
actions.user.private_cursorless_run_rpc_command_no_wait(
57+
"cursorless.tutorial.restart"
58+
)
59+
60+
def private_cursorless_tutorial_resume():
61+
"""Cursorless tutorial: resume"""
62+
actions.user.private_cursorless_run_rpc_command_no_wait(
63+
"cursorless.tutorial.resume"
64+
)
65+
66+
def private_cursorless_tutorial_list():
67+
"""Cursorless tutorial: list all available tutorials"""
68+
actions.user.private_cursorless_run_rpc_command_no_wait(
69+
"cursorless.tutorial.list"
70+
)
71+
72+
def private_cursorless_tutorial_start_by_number(number: int): # pyright: ignore [reportGeneralTypeIssues]
73+
"""Start Cursorless tutorial by number"""
74+
actions.user.private_cursorless_run_rpc_command_no_wait(
75+
"cursorless.tutorial.start", number - 1
76+
)
77+
78+
79+
@global_ctx.action_class("user")
80+
class GlobalActions:
81+
def private_cursorless_notify_docs_opened():
82+
# Do nothing if we're not in a Cursorless context
83+
pass
84+
85+
86+
@cursorless_ctx.action_class("user")
87+
class CursorlessActions:
88+
def private_cursorless_notify_docs_opened():
89+
actions.user.private_cursorless_run_rpc_command_no_wait("cursorless.docsOpened")

‎cursorless-talon/src/cursorless.talon‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,13 @@ bar {user.cursorless_homophone}:
3737

3838
{user.cursorless_homophone} stats:
3939
user.private_cursorless_show_command_statistics()
40+
41+
{user.cursorless_homophone} tutorial:
42+
user.private_cursorless_start_tutorial()
43+
tutorial next: user.private_cursorless_tutorial_next()
44+
tutorial (previous | last): user.private_cursorless_tutorial_previous()
45+
tutorial restart: user.private_cursorless_tutorial_restart()
46+
tutorial resume: user.private_cursorless_tutorial_resume()
47+
tutorial (list | close): user.private_cursorless_tutorial_list()
48+
tutorial <user.private_cursorless_number_small>:
49+
user.private_cursorless_tutorial_start_by_number(private_cursorless_number_small)

‎data/fixtures/recorded/tutorial/unit-1-basics/changeSit.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
languageId: plaintext
2+
command:
3+
version: 7
4+
spokenForm: change sit
5+
action:
6+
name: clearAndSetSelection
7+
target:
8+
type: primitive
9+
mark: {type: decoratedSymbol, symbolColor: default, character: i}
10+
usePrePhraseSnapshot: true
11+
initialState:
12+
documentContents: |
13+
Welcome Cursorless!
14+
15+
Notice the hats above each word in this sentence.
16+
selections:
17+
- anchor: {line: 2, character: 15}
18+
active: {line: 2, character: 15}
19+
marks:
20+
default.i:
21+
start: {line: 2, character: 32}
22+
end: {line: 2, character: 34}
23+
finalState:
24+
documentContents: |
25+
Welcome Cursorless!
26+
27+
Notice the hats above each word this sentence.
28+
selections:
29+
- anchor: {line: 2, character: 32}
30+
active: {line: 2, character: 32}

‎data/fixtures/recorded/tutorial/unit-1-basics/chuckLineOdd.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
languageId: plaintext
2+
command:
3+
version: 7
4+
spokenForm: chuck line odd
5+
action:
6+
name: remove
7+
target:
8+
type: primitive
9+
mark: {type: decoratedSymbol, symbolColor: default, character: o}
10+
modifiers:
11+
- type: containingScope
12+
scopeType: {type: line}
13+
usePrePhraseSnapshot: true
14+
initialState:
15+
documentContents: |-
16+
Welcome Cursorless!
17+
18+
Notice the hats above each word in this sentence.
19+
20+
Now, see the sidebar.
21+
selections:
22+
- anchor: {line: 2, character: 0}
23+
active: {line: 2, character: 6}
24+
- anchor: {line: 2, character: 35}
25+
active: {line: 2, character: 39}
26+
marks:
27+
default.o:
28+
start: {line: 4, character: 0}
29+
end: {line: 4, character: 3}
30+
finalState:
31+
documentContents: |
32+
Welcome Cursorless!
33+
34+
Notice the hats above each word in this sentence.
35+
selections:
36+
- anchor: {line: 2, character: 0}
37+
active: {line: 2, character: 6}
38+
- anchor: {line: 2, character: 35}
39+
active: {line: 2, character: 39}

‎data/fixtures/recorded/tutorial/unit-1-basics/chuckTrap.yml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
languageId: plaintext
2+
command:
3+
version: 7
4+
spokenForm: chuck trap
5+
action:
6+
name: remove
7+
target:
8+
type: primitive
9+
mark: {type: decoratedSymbol, symbolColor: default, character: t}
10+
usePrePhraseSnapshot: true
11+
initialState:
12+
documentContents: |-
13+
Welcome to Cursorless!
14+
15+
Notice the hats above each word in this sentence.
16+
17+
Now, see the sidebar.
18+
selections:
19+
- anchor: {line: 2, character: 0}
20+
active: {line: 2, character: 6}
21+
- anchor: {line: 2, character: 35}
22+
active: {line: 2, character: 39}
23+
marks:
24+
default.t:
25+
start: {line: 0, character: 8}
26+
end: {line: 0, character: 10}
27+
finalState:
28+
documentContents: |-
29+
Welcome Cursorless!
30+
31+
Notice the hats above each word in this sentence.
32+
33+
Now, see the sidebar.
34+
selections:
35+
- anchor: {line: 2, character: 0}
36+
active: {line: 2, character: 6}
37+
- anchor: {line: 2, character: 35}
38+
active: {line: 2, character: 39}

‎data/fixtures/recorded/tutorial/unit-1-basics/postAir.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
languageId: plaintext
2+
command:
3+
version: 7
4+
spokenForm: post air
5+
action:
6+
name: setSelectionAfter
7+
target:
8+
type: primitive
9+
mark: {type: decoratedSymbol, symbolColor: default, character: a}
10+
usePrePhraseSnapshot: true
11+
initialState:
12+
documentContents: |
13+
Welcome Cursorless!
14+
15+
Notice the hats above each word in this sentence.
16+
selections:
17+
- anchor: {line: 0, character: 8}
18+
active: {line: 0, character: 8}
19+
marks:
20+
default.a:
21+
start: {line: 2, character: 11}
22+
end: {line: 2, character: 15}
23+
finalState:
24+
documentContents: |
25+
Welcome Cursorless!
26+
27+
Notice the hats above each word in this sentence.
28+
selections:
29+
- anchor: {line: 2, character: 15}
30+
active: {line: 2, character: 15}

0 commit comments

Comments
 (0)