Cursorless tutorial units 1 & 2

[pokey]

Initial content for a cursorless tutorial

• I have added tests
• Properly support custom actions and other necessary custom spoken forms
• Properly support custom symbol spoken forms (eg alphabet)
• Add note at end of unit 1 suggesting they continue to play with the document
• Tune tutorial content. Move / add docs tip to end of first tutorial. More stuff maybe better for follow-up PR
• Make hat forcing more robust?
• Show pop-up on install prompting them to do the tutorial. Prob should show pop-up even not on first install?
• Store current progress in local storage (and sync it)
• I have updated the docs and cheatsheet
• I have not broken the cheatsheet
• Fix scope tree view
• How to handle disabled hat color?
• Figure out unicode for emoji
• Figure out what "cursorless tutorial" should actually do. Currently starts second tutorial, which is obv not what we want
• Figure out how to advance from last step of initial tutorial, as it has no action to perform
• Add "tutorial next" / "tutorial previous" commands
• Add tutorial step saying to use "cursorless help" cheatsheat
• Fix broken references to css eg reset
• Invalidate state if custom spoken forms change
• Change view when we detect that prereqs are no longer met (eg cursor in wrong place, etc). Indicate they should say "tutorial continue" / "tutorial restore" / "cursorless tutorial" to reset the prereqs
• Merge HUD changes
• Figure out how to properly detect VSCode focused
• Highlight marks that need to be targeted, so user doesn't have to search for them
• Remove print statements and commented out code from tutorial.py
• Figure out how to only run step preparation when you have the right window focused. Some of the time @pokey gets error message after "cursorles help" step
  
• Open new window on start?
• Ensure you're in the right window / editor before restoring state, so we don't accidentally clobber something
• Get it to work with mainline Talon HUD
• Finish constructing spoken forms from commands
• Use app name for VSCode that works cross-platform
• Figure out what todo with the fact that the cheatsheet clobbers the entire screen and you can't even see the close button (Reimplement cheatsheet using html #619)

See also cursorless-dev/cursorless-talon#143

Unit 2

• Python
• Have an action class?

To cover:

• New scope types
• New actions, including
  • single argument "bring"
  • multiple argument "bring"
  • "move"
  • "swap"
• Simple inference in the context of multiple target actions such as swap or bring

Extra unit

• Probably want to move this into a new pull request
• Create a json script for it
• Don't forget to add the intermediate steps where it was not a cursorless command and so isn't recorded

Links

Helpful places in our code base

• https://github.com/cursorless-dev/cursorless/blob/main/packages/cursorless-vscode-e2e/src/suite/recorded.vscode.test.ts sets up file to initial state of tutorial step
• to generate a spoken form from the command payload in the yaml:

  cursorless/packages/cursorless-engine/src/scopeProviders/ScopeInfoProvider.ts

  Line 95 in a9cc79f

  this.customSpokenFormGenerator.scopeTypeToSpokenForm(scopeType),

• this is where you'll send a command to cursorless requesting it to set up initial tutorial step state and have it return generated spoken form: https://github.com/cursorless-dev/cursorless/pull/360/files#diff-5c1cd9d422f7c8df0325fd0958446c90873fb338c462287ef5f57606a363658bR35-R37
• registering a new command extension-side

  cursorless/packages/cursorless-vscode/src/extension.ts

  Line 125 in a9cc79f

  registerCommands(

In case we decided to look into VSCode walkthroughs rather than Talon hud

• https://code.visualstudio.com/api/references/contribution-points#contributes.walkthroughs

[pokey]

Closing until this becomes an active priority again

[imochoa]

I'm really excited for this :)