Snippet wrap

.eslintrc.json

@@ -21,5 +21,9 @@
         ],
         "no-throw-literal": "warn",
         "semi": "off"
-    }
+    },
+    "ignorePatterns": [
+        "**/vendor/**/*.ts",
+        "**/vendor/**/*.js"
+    ]
 }

.vscode/launch.json

@@ -36,6 +36,25 @@
 				"${workspaceFolder}/out/test/**/*.js"
 			],
 			"preLaunchTask": "${defaultBuildTask}"
+		},
+		{
+			"name": "Update fixtures",
+			"type": "extensionHost",
+			"request": "launch",
+			"env": {
+				"CURSORLESS_TEST": "true",
+				"CURSORLESS_TEST_UPDATE_FIXTURES": "true",
+			},
+			"args": [
+				"--disable-extension",
+				"asvetliakov.vscode-neovim",
+				"--extensionDevelopmentPath=${workspaceFolder}",
+				"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
+			],
+			"outFiles": [
+				"${workspaceFolder}/out/test/**/*.js"
+			],
+			"preLaunchTask": "${defaultBuildTask}"
 		}
 	]
 }

cursorless-snippets/ifElseStatement.cursorless-snippets

@@ -0,0 +1,49 @@
+{
+  "ifElseStatement": {
+    "definitions": [
+      {
+        "scope": {
+          "langIds": [
+            "typescript",
+            "typescriptreact",
+            "javascript",
+            "javascriptreact",
+            "cpp",
+            "c",
+            "java",
+            "csharp"
+          ]
+        },
+        "body": [
+          "if ($condition) {",
+          "\t$consequence",
+          "} else {",
+          "\t$alternative",
+          "}"
+        ]
+      },
+      {
+        "scope": {
+          "langIds": [
+            "python"
+          ]
+        },
+        "body": [
+          "if $condition:",
+          "\t$consequence",
+          "else:",
+          "\t$alternative"
+        ]
+      }
+    ],
+    "description": "If else statement",
+    "variables": {
+      "consequence": {
+        "wrapperScopeType": "statement"
+      },
+      "alternative": {
+        "wrapperScopeType": "statement"
+      }
+    }
+  }
+}

cursorless-snippets/ifStatement.cursorless-snippets

@@ -0,0 +1,42 @@
+{
+  "ifStatement": {
+    "definitions": [
+      {
+        "scope": {
+          "langIds": [
+            "typescript",
+            "typescriptreact",
+            "javascript",
+            "javascriptreact",
+            "cpp",
+            "c",
+            "java",
+            "csharp"
+          ]
+        },
+        "body": [
+          "if ($condition) {",
+          "\t$consequence",
+          "}"
+        ]
+      },
+      {
+        "scope": {
+          "langIds": [
+            "python"
+          ]
+        },
+        "body": [
+          "if $condition:",
+          "\t$consequence"
+        ]
+      }
+    ],
+    "description": "If statement",
+    "variables": {
+      "consequence": {
+        "wrapperScopeType": "statement"
+      }
+    }
+  }
+}

cursorless-snippets/tryCatchStatement.cursorless-snippets

@@ -0,0 +1,49 @@
+{
+  "tryCatchStatement": {
+    "definitions": [
+      {
+        "scope": {
+          "langIds": [
+            "typescript",
+            "typescriptreact",
+            "javascript",
+            "javascriptreact",
+            "cpp",
+            "c",
+            "java",
+            "csharp"
+          ]
+        },
+        "body": [
+          "try {",
+          "\t$body",
+          "} catch ($error) {",
+          "\t$exceptBody",
+          "}"
+        ]
+      },
+      {
+        "scope": {
+          "langIds": [
+            "python"
+          ]
+        },
+        "body": [
+          "try:",
+          "\t$body",
+          "except $error:",
+          "\t$exceptBody"
+        ]
+      }
+    ],
+    "description": "Try catch statement",
+    "variables": {
+      "body": {
+        "wrapperScopeType": "statement"
+      },
+      "exceptBody": {
+        "wrapperScopeType": "statement"
+      }
+    }
+  }
+}

docs/experimental/snippets.md

@@ -0,0 +1,5 @@
+# Cursorless snippets
+
+Cursorless has experimental support for snippets. Currently these snippets are just used for wrapping targets.
+
+The best place to start is to look at the [core cursorless snippets](../../cursorless-snippets). Additionally, there is autocomplete with documentation as you're writing a snippet.

package.json

@@ -400,9 +400,27 @@
 							"verticalOffset": 0
 						}
 					}
+				},
+				"cursorless.experimental.snippetsDir": {
+					"description": "Directory containing snippets for use in cursorless",
+					"type": "string"
 				}
 			}
-		}
+		},
+		"languages": [
+			{
+				"id": "json",
+				"extensions": [
+					".cursorless-snippets"
+				]
+			}
+		],
+		"jsonValidation": [
+			{
+				"fileMatch": "*.cursorless-snippets",
+				"url": "./schemas/cursorless-snippets.json"
+			}
+		]
 	},
 	"scripts": {
 		"vscode:prepublish": "npm run -S esbuild-base -- --minify",
@@ -420,7 +438,7 @@
 		"@types/glob": "^7.1.3",
 		"@types/js-yaml": "^4.0.2",
 		"@types/mocha": "^8.0.4",
-		"@types/node": "^12.11.7",
+		"@types/node": "^16.11.3",
 		"@types/sinon": "^10.0.2",
 		"@types/vscode": "^1.53.0",
 		"@typescript-eslint/eslint-plugin": "^4.9.0",
@@ -432,12 +450,12 @@
 		"js-yaml": "^4.1.0",
 		"mocha": "^8.1.3",
 		"sinon": "^11.1.1",
-		"typescript": "^4.1.2",
+		"typescript": "^4.4.4",
 		"vscode-test": "^1.4.1"
 	},
 	"dependencies": {
 		"@types/lodash": "^4.14.168",
 		"immutability-helper": "^3.1.1",
 		"lodash": "^4.17.21"
 	}
-}
+}

schemas/cursorless-snippets.json

@@ -0,0 +1,97 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Snippets for use in cursorless",
+    "type": "object",
+    "additionalProperties": {
+        "type": "object",
+        "properties": {
+            "definitions": {
+                "type": "array",
+                "descriptions": "List of possible definitions for this snippet",
+                "items": {
+                    "type": "object",
+                    "properties": {
+                        "scope": {
+                            "type": "object",
+                            "description": "Scopes where this snippet is active",
+                            "properties": {
+                                "langIds": {
+                                    "type": "array",
+                                    "items": {
+                                        "type": "string"
+                                    }
+                                },
+                                "scopeType": {
+                                    "$ref": "#/$defs/scopeType",
+                                    "description": "Cursorless scopes in which this snippet is active.  Allows, for example, to have different snippets to define a function if you're in a class or at global scope."
+                                }
+                            }
+                        },
+                        "body": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            },
+                            "description": "Inline snippet text using VSCode snippet syntax; entries joined by newline.  Named variables of the form $foo can be used as wrappers"
+                        }
+                    },
+                    "required": [
+                        "body"
+                    ]
+                }
+            },
+            "variables": {
+                "type": "object",
+                "description": "For each named variable in the snippet, provides extra information about the variable.",
+                "additionalProperties": {
+                    "type": "object",
+                    "properties": {
+                        "wrapperScopeType": {
+                            "$ref": "#/$defs/scopeType",
+                            "description": "Default to this scope type when wrapping a target without scope type specified"
+                        },
+                        "description": {
+                            "type": "string",
+                            "description": "Description of the snippet variable"
+                        }
+                    }
+                }
+            },
+            "description": {
+                "type": "string",
+                "description": "Description of the snippet"
+            }
+        }
+    },
+    "$defs": {
+        "scopeType": {
+            "type": "string",
+            "enum": [
+                "argumentOrParameter",
+                "anonymousFunction",
+                "attribute",
+                "class",
+                "className",
+                "collectionItem",
+                "collectionKey",
+                "comment",
+                "functionCall",
+                "functionName",
+                "ifStatement",
+                "list",
+                "map",
+                "name",
+                "namedFunction",
+                "regularExpression",
+                "statement",
+                "string",
+                "type",
+                "value",
+                "xmlBothTags",
+                "xmlElement",
+                "xmlEndTag",
+                "xmlStartTag"
+            ]
+        }
+    }
+}

src/actions/BringMoveSwap.ts

@@ -31,7 +31,7 @@ interface MarkEntry {
 }
 
 class BringMoveSwap implements Action {
-  targetPreferences: ActionPreferences[] = [
+  getTargetPreferences: () => ActionPreferences[] = () => [
     { insideOutsideType: null },
     { insideOutsideType: null },
   ];

src/actions/Call.ts

@@ -8,7 +8,7 @@ import {
 import { ensureSingleTarget } from "../util/targetUtils";
 
 export default class Call implements Action {
-  targetPreferences: ActionPreferences[] = [
+  getTargetPreferences: () => ActionPreferences[] = () => [
     { insideOutsideType: "inside" },
     { insideOutsideType: "inside" },
   ];

src/actions/Clear.ts

@@ -9,7 +9,7 @@ import { ensureSingleEditor } from "../util/targetUtils";
 import { setSelectionsAndFocusEditor } from "../util/setSelectionsAndFocusEditor";
 
 export default class Clear implements Action {
-  targetPreferences: ActionPreferences[] = [{ insideOutsideType: "inside" }];
+  getTargetPreferences: () => ActionPreferences[] = () => [{ insideOutsideType: "inside" }];
 
   constructor(private graph: Graph) {
     this.run = this.run.bind(this);

src/actions/CommandAction.ts

@@ -18,7 +18,7 @@ import { callFunctionAndUpdateSelections } from "../util/updateSelections";
 import { ensureSingleEditor } from "../util/targetUtils";
 
 export default class CommandAction implements Action {
-  targetPreferences: ActionPreferences[] = [{ insideOutsideType: "inside" }];
+  getTargetPreferences: () => ActionPreferences[] = () => [{ insideOutsideType: "inside" }];
   private ensureSingleEditor: boolean;
 
   constructor(

src/actions/CopyLines.ts

@@ -14,7 +14,7 @@ import unifyRanges from "../util/unifyRanges";
 import expandToContainingLine from "../util/expandToContainingLine";
 
 class CopyLines implements Action {
-  targetPreferences: ActionPreferences[] = [{ insideOutsideType: "inside" }];
+  getTargetPreferences: () => ActionPreferences[] = () => [{ insideOutsideType: "inside" }];
 
   constructor(private graph: Graph, private isUp: boolean) {
     this.run = this.run.bind(this);

src/actions/CutCopyPaste.ts

@@ -12,7 +12,7 @@ import { getOutsideOverflow } from "../util/targetUtils";
 import { zip } from "lodash";
 
 export class Cut implements Action {
-  targetPreferences: ActionPreferences[] = [{ insideOutsideType: null }];
+  getTargetPreferences: () => ActionPreferences[] = () => [{ insideOutsideType: null }];
 
   constructor(private graph: Graph) {
     this.run = this.run.bind(this);