Skip to content

Commit 0570ff8

Browse files
committed
Update cheatsheet
1 parent e5e9929 commit 0570ff8

File tree

2 files changed

+130
-7
lines changed

2 files changed

+130
-7
lines changed

packages/cheatsheet/src/lib/sampleSpokenFormInfos/defaults.json

Lines changed: 117 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,36 @@
44
"name": "Actions",
55
"id": "actions",
66
"items": [
7+
{
8+
"id": "addSelection",
9+
"type": "action",
10+
"variations": [
11+
{
12+
"spokenForm": "append <target>",
13+
"description": "Add selection"
14+
}
15+
]
16+
},
17+
{
18+
"id": "addSelectionAfter",
19+
"type": "action",
20+
"variations": [
21+
{
22+
"spokenForm": "append post <target>",
23+
"description": "Add selection after"
24+
}
25+
]
26+
},
27+
{
28+
"id": "addSelectionBefore",
29+
"type": "action",
30+
"variations": [
31+
{
32+
"spokenForm": "append pre <target>",
33+
"description": "Add selection before"
34+
}
35+
]
36+
},
737
{
838
"id": "applyFormatter",
939
"type": "action",
@@ -138,6 +168,16 @@
138168
}
139169
]
140170
},
171+
{
172+
"id": "flashTargets",
173+
"type": "action",
174+
"variations": [
175+
{
176+
"spokenForm": "flash <target>",
177+
"description": "Flash targets"
178+
}
179+
]
180+
},
141181
{
142182
"id": "foldRegion",
143183
"type": "action",
@@ -173,11 +213,51 @@
173213
"type": "action",
174214
"variations": [
175215
{
176-
"spokenForm": "snippet make <target>",
216+
"spokenForm": "snip make <target>",
177217
"description": "Generate snippet"
178218
}
179219
]
180220
},
221+
{
222+
"id": "gitAccept",
223+
"type": "action",
224+
"variations": [
225+
{
226+
"spokenForm": "git accept <target>",
227+
"description": "Git accept"
228+
}
229+
]
230+
},
231+
{
232+
"id": "gitRevert",
233+
"type": "action",
234+
"variations": [
235+
{
236+
"spokenForm": "git revert <target>",
237+
"description": "Git revert"
238+
}
239+
]
240+
},
241+
{
242+
"id": "gitStage",
243+
"type": "action",
244+
"variations": [
245+
{
246+
"spokenForm": "git stage <target>",
247+
"description": "Git stage"
248+
}
249+
]
250+
},
251+
{
252+
"id": "gitUnstage",
253+
"type": "action",
254+
"variations": [
255+
{
256+
"spokenForm": "git unstage <target>",
257+
"description": "Git unstage"
258+
}
259+
]
260+
},
181261
{
182262
"id": "highlight",
183263
"type": "action",
@@ -263,7 +343,7 @@
263343
"type": "action",
264344
"variations": [
265345
{
266-
"spokenForm": "snippet <target>",
346+
"spokenForm": "snip <target>",
267347
"description": "Insert snippet"
268348
}
269349
]
@@ -906,14 +986,14 @@
906986
"spokenForm": "previous <scope>",
907987
"description": "Previous instance of <scope>"
908988
},
909-
{
910-
"spokenForm": "next <scope>",
911-
"description": "Next instance of <scope>"
912-
},
913989
{
914990
"spokenForm": "<ordinal> previous <scope>",
915991
"description": "<ordinal> instance of <scope> before target"
916992
},
993+
{
994+
"spokenForm": "next <scope>",
995+
"description": "Next instance of <scope>"
996+
},
917997
{
918998
"spokenForm": "<ordinal> next <scope>",
919999
"description": "<ordinal> instance of <scope> after target"
@@ -1126,6 +1206,16 @@
11261206
}
11271207
]
11281208
},
1209+
{
1210+
"id": "string",
1211+
"type": "pairedDelimiter",
1212+
"variations": [
1213+
{
1214+
"spokenForm": "string",
1215+
"description": "String"
1216+
}
1217+
]
1218+
},
11291219
{
11301220
"id": "whitespace",
11311221
"type": "pairedDelimiter",
@@ -1222,7 +1312,17 @@
12221312
"variations": [
12231313
{
12241314
"spokenForm": "short paint",
1225-
"description": "Non whitespace sequence stopped by surrounding pair delimeters"
1315+
"description": "Non-whitespace sequence bounded by surrounding pair delimeters"
1316+
}
1317+
]
1318+
},
1319+
{
1320+
"id": "boundedParagraph",
1321+
"type": "scopeType",
1322+
"variations": [
1323+
{
1324+
"spokenForm": "short block",
1325+
"description": "Paragraph bounded by surrounding pair delimeters"
12261326
}
12271327
]
12281328
},
@@ -1496,6 +1596,16 @@
14961596
}
14971597
]
14981598
},
1599+
{
1600+
"id": "pair",
1601+
"type": "scopeType",
1602+
"variations": [
1603+
{
1604+
"spokenForm": "<pair>",
1605+
"description": "Paired delimiters"
1606+
}
1607+
]
1608+
},
14991609
{
15001610
"id": "paragraph",
15011611
"type": "scopeType",

packages/cursorless-org-docs/src/docs/contributing/CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,19 @@ To uninstall the local build and revert to production cursorless, run the follow
139139
pnpm -F cursorless-vscode uninstall-local
140140
```
141141

142+
## Regular manual maintenance tasks
143+
144+
### Updating the cheatsheet
145+
146+
We need to keep the default cheatsheet up-to-date for use with local development and for https://www.cursorless.org/cheatsheet.
147+
148+
1. Switch to vanilla knausj + cursorless_talon
149+
2. "debug stench"
150+
3. "cursorless update cheatsheet"
151+
4. See diff and cleanup if necessary
152+
153+
This should be done every time we do something that will change the custom cheatsheet, but in practice it rots a bit so needs to be redone regularly.
154+
142155
## Changing SVGs
143156

144157
### SVG preprocessing script

0 commit comments

Comments
 (0)