Add a spec for "Snippets"

[zadjii-msft]

This specs out a lot of plans for snippets. We've already got these in the sxnui as "tasks", but we can do so very much more.

This spec is a few years old now, but it's time for it to get promoted out of my draft branch.

References:

• Feature Request - Scripts Panel #1595
• Don't localize command names on the command palette #7039
• Enhance shell autocompletion with a cool new user interface and shell completion protocol #3121
• Add an Extensions page to the SUI #10436
• Allow sendInput to have promptable sections for further completion #12927
• Ability to save selected text as a sendInput action #12857
• Method to suppress the default CTRL+C/CTRL+V mapping specifically for WSL; profile-specific keybindings? #5790
• Suggestions UI ship list #15845

[carlos-zamora]

For accessibility, remember to set the help text for the comment. Tooltips aren't really accessible since they may disappear.

[zadjii-msft]

Ah but it isn't a Tooltip, it's something more ☺️

[zadjii-msft]

Notes from spec review:

• We should have a toast to trust things in the CWD, ala vscode trusting workspaces (store in state)
• Remove the whole section on wt.json in the command palette. f it. it can just be in the sxnui
• Specific discussion on syntax for this file: JSON? fragment JSON? some other subset?
• Do it like the snippets json below[1]
• "The exact syntax as follows" is on wrong line
• Just don't parse the saveSnippet action, cause what's even the point
• clarify and elaborate on the "children supersede parents"
• future consideration: snippets pane can prompt to add new snippet
• leave wt save experimental for a while, probably until there's a dedicated save dialog. Commandline string escaping and quote parsing is neigh impossible
• at least toast if we fail to load .wt.json for sxnui, snippets pane can also just display the error
• v2: can we just use tasks.json syntax from vscode?
  • left as future consideration, cause those are FAR more powerful than what we're going to do now
• do we need to do due diligence that we're reading arbitrary files off the file system?
• Unanimous consent vote: .wt.json it is.

[1]: the json:

  {
    "$version": "1.0.0",
    "snippets":
    [
        {
            "input": "bx\r" 
            "name": "Build project",
            "description": "Build the project in the CWD"
        },

[zadjii-msft]

b999c51 has all the feedback from the review yesterday

[carlos-zamora]

Blocking over:

• Command Palette discussion (like, adding in the discussion points)
• discussion on .wt.json being next to the settings.json (see crazy idea below)

Crazy idea: what if we hard commit to snippets only being in .wt.json files?

Here's what I mean:

• .wt.json files in the same directory as settings.json will be automatically loaded
• (Migration) sendInput actions in settings.json will be moved to the local .wt.json file
• Users can save .wt.json files from a separate repo to their local directory (besides the settings.json) so that they always have access to them
• saveSnippet/x-save saves the snippet to the .wt.json

[zadjii-msft]

Crazy idea: what if we hard commit to snippets only being in .wt.json files

Meh? I dunno, I'm not sure how valuable that is beyond just having a .wt.json that you stick in your dotfiles repo, then always stick in the root of the filesystem. Or just leaving then in the settings file. Just kinda feels like churn. I feel like all the user's settings they own should probably just stay in the one settings file we've already got.

I'd be open to promoting sendInput from just an action to just a general snippets property in the settings.json itself. That's not too crazy.

[carlos-zamora]

Thanks for bearing with me. Excited for Snippets! 🎉

[DHowett]

R+ let's GOOOO

[PankajBhojwani]

nervous excitement

[zadjii-msft]

yOu CaNt UsE gItHuB aS aN iMaGe HoSt