Make cheat sheet handle missing spoken forms #2760
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
phillco
reviewed
Jan 25, 2025
Comment on lines
43
to
60
| if "replaceWithTarget" in complex_actions: | ||
| items.append( | ||
| { | ||
| "id": "replaceWithTarget", | ||
| "type": "action", | ||
| "variations": [ | ||
| { | ||
| "spokenForm": f"{complex_actions['replaceWithTarget']} <target> <destination>", | ||
| "description": "Copy <target> to <destination>", | ||
| }, | ||
| { | ||
| "spokenForm": f"{complex_actions['replaceWithTarget']} <target>", | ||
| "description": "Insert copy of <target> at cursor", | ||
| }, | ||
| ], | ||
| } | ||
| ) | ||
|
|
There was a problem hiding this comment.
There's a bit of duplication here and this switches from defining a data structure to a fair bit of imperative code, but I think we could reduce it.
Why not something like a dictionary of tuples (one description and one lambda that generates the spoken form?):
{
"replaceWithTarget": ("Copy <target> to <destination>", lambda value: f"{value} <target> <destination>"),
}Then we could just use a loop to generate all of these and remove some the duplication.
Not sure if you could refer to stuff outside of the scope like swap_connective but I think it's helpful either way, if not that means the more complicated ones will stay as imperative code, which I think itself helps with readability.
There was a problem hiding this comment.
Better like this?
phillco
reviewed
Jan 26, 2025
phillco
approved these changes
Jan 28, 2025
phillco
approved these changes
Jan 28, 2025
cursorless-bot
pushed a commit
that referenced
this pull request
Jan 28, 2025
Today the cheat sheet generation crashes if the user has disabled certain spoken forms Fixes #2647 ## Checklist - [/] 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Today the cheat sheet generation crashes if the user has disabled certain spoken forms
Fixes #2647
Checklist