Snippet wrap by pokey · Pull Request #296 · cursorless-dev/cursorless

pokey · 2021-10-15T14:53:31Z

Closes #21

Switch to cursorless.wrappers.scopeTypes for settings
Switch to use language-specific settings instead of language mapping to simplify implementation and make it easier to configure
Allow snippets to signal their preferred scope type
Support user snippets? If so, we'd prob also want a way to signal what their preferred scope type is
Return that mark

pokey · 2021-10-15T18:45:00Z

@AndreasArvidsson looks like this is failing because the snippet inserts \r\n on windows. Any ideas how to fix? Should we set line ending for all of our tests unless they have a special flag in the yaml?

pokey · 2021-10-17T17:39:24Z

package.json

 					}
+				},
+				"cursorless.wrapperSnippetPreferences": {
+					"description": "Allows snippets to signal what their default scope types etcetera should be",


Down the road we may allow signalling things like selectionType, etc, so I figured let's have this be a map

pokey · 2021-10-17T17:39:59Z

package.json

+						"properties": {
+							"scopeType": {
+								"type": "string",
+								"enum": [


This enum will get stale, but I don't think it will cause any serious problems, and the autocomplete will be nice

pokey · 2021-10-17T17:40:42Z

snippets/cpp.json

@@ -0,0 +1,26 @@
+{


Decided to duplicate these snippets between languages as I'd imagine they'll start to diverge. but easy to just use one file as well

pokey · 2021-10-17T17:41:24Z

src/actions/BringMoveSwap.ts


 class BringMoveSwap implements Action {
-  targetPreferences: ActionPreferences[] = [
+  getTargetPreferences: () => ActionPreferences[] = () => [


We now have a function to give action a chance to see args

pokey · 2021-10-17T17:42:46Z

src/actions/WrapWithSnippet.ts

+
+export default class WrapWithSnippet implements Action {
+  getTargetPreferences(
+    partialTargets: PartialTarget[],


We have this arg here so that below FIXME can be implemented in the future. Mixed feelings about letting action see this thing but not sure how else to let it do something like figure out which editor a target is referring to

pass in context object with callbacks instead

pokey · 2021-10-17T17:46:41Z

src/test/suite/fixtures/recorded/languages/cpp/tryCatchWrapThis2.yml

@@ -0,0 +1,47 @@
+spokenForm: try catch wrap this


Test for multiple cursors

pokey · 2021-10-17T17:50:09Z

src/test/suite/recorded.test.ts

  });
  const editor = await vscode.window.showTextDocument(document);

+  if (!fixture.initialState.documentContents.includes("\n")) {


This seemed reasonable to me and doesn't break your line ending tests

pokey · 2021-10-17T17:52:46Z

src/test/suite/recorded.test.ts

-  );
+  if (process.env.CURSORLESS_TEST_UPDATE_FIXTURES == "true") {
+    const outputFixture = { ...fixture, finalState: resultState, returnValue };
+    await fsp.writeFile(file, serialize(outputFixture));


Easy way to update snapshots

pokey · 2021-10-17T17:52:54Z

.vscode/launch.json

 			"preLaunchTask": "${defaultBuildTask}"
+		},
+		{
+			"name": "Update fixtures",


Easy way to update snapshots

pokey

remove prefixes so just ifStatement
double-check that can say "if wrap token air"

pokey · 2021-10-20T10:08:07Z

package.json

 						}
 					}
+				},
+				"cursorless.wrapperSnippetPreferences": {


have a cursorless.snippets setting with just a defaultScopeType property.

pokey · 2021-10-20T10:14:07Z

src/actions/Sort.ts


 export class Sort implements Action {
-  targetPreferences: ActionPreferences[] = [{ insideOutsideType: "inside" }];
+  getTargetPreferences: () => ActionPreferences[] = () => [{ insideOutsideType: "inside" }];


see if i can get rid of type here

pokey · 2021-10-20T10:19:31Z

src/actions/WrapWithSnippet.ts

+
+export default class WrapWithSnippet implements Action {
+  getTargetPreferences(
+    partialTargets: PartialTarget[],


pass in context object with callbacks instead

pokey · 2021-10-21T13:54:35Z

package.json

+						"ifElseStatement": {
+							"definitions": [
+								{
+									"scope": {
+										"langIds": [
+											"typescript",
+											"typescriptreact",
+											"javascript",
+											"javascriptreact",
+											"cpp",
+											"c",
+											"java",
+											"csharp"
+										]
+									},
+									"body": [
+										"if ($condition) {\n\t$consequence\n} else {\n\t$alternative\n}"
+									]
+								},
+								{
+									"scope": {
+										"langIds": [
+											"python"
+										]
+									},
+									"body": [
+										"if $condition:\n\t$consequence\nelse:\n\t$alternative"
+									]
+								}
+							],
+							"defaultScopeTypes": {
+								"consequence": "statement",
+								"alternative": "statement"
+							},
+							"description": "If else statement"
+						}


@AndreasArvidsson wdyt? See how we have a single snippet for if / else?

pokey · 2021-10-21T13:55:54Z

package.json

+														"type": "string"
+													}
+												},
+												"scopeType": {


This scopeType isn't yet supported, but will allow us to differentiate "snip funk" in a class vs top-level in the future, as discussed

pokey · 2021-10-21T13:56:08Z

package.json

 						}
 					}
+				},
+				"cursorless.experimental.snippets": {


Tagged the setting as experimental

pokey · 2021-10-21T15:13:46Z

package.json

+					"type": "object",
+					"default": {
+						"ifStatement": {
+							"definitions": [],


We put the definitions elsewhere so that the user can easily put their own, which take precedence over built-in ones

pokey · 2021-10-21T15:39:54Z

src/core/inferFullTargets.ts

  const selectionType =
-    maybeSelectionType ?? actionPreferences.selectionType ?? "token";
+    maybeSelectionType ??
+    (target.modifier == null ? actionPreferences.selectionType : null) ??


Basically a hack until we merge scopeType and selectionType using pipeline support

pokey · 2021-10-21T15:43:05Z

src/vendor/snippet/charCode.ts

@@ -0,0 +1,436 @@
+/*---------------------------------------------------------------------------------------------


We vendor in vscode snippet parser. I don't feel great about it. But I think it should be ok as snippet syntax shouldn't change too fast

pokey · 2021-10-23T13:46:45Z

package.json

+		],
+		"jsonValidation": [
+			{
+				"fileMatch": "*.cursorless-snippets",


This extension is a bit verbose; open to suggestions. Need some way to indicate that the file should be checked by the schema on the next line so that user gets autocomplete

pokey · 2021-10-23T13:51:43Z

package.json

 		"mocha": "^8.1.3",
 		"sinon": "^11.1.1",
-		"typescript": "^4.1.2",
+		"typescript": "^4.4.4",


Note the typescript version bump

pokey · 2021-10-23T14:47:55Z

src/extension.ts

    sourceMark,
    addDecorations,
+    experimental: {
+      registerThirdPartySnippets: graph.snippets.registerThirdPartySnippets,


Seemed super easy to support third-party snippets so I just decided implement it

pokey · 2021-10-23T14:58:33Z

src/core/Snippets.ts

+    this.registerThirdPartySnippets =
+      this.registerThirdPartySnippets.bind(this);
+
+    const timer = setInterval(


Note that we just poll the user snippet dir, but we check modification times and don't do anything if nothing has changed

pokey · 2021-10-23T15:01:54Z

src/util/graphFactories.ts

@@ -0,0 +1,15 @@
+import Actions from "../actions";


We use factories now so that we can add the extension context, which is not a class

pokey requested a review from AndreasArvidsson October 15, 2021 14:55

pokey marked this pull request as draft October 15, 2021 18:45

pokey removed the request for review from AndreasArvidsson October 15, 2021 18:45

pokey mentioned this pull request Oct 15, 2021

Snippet wrap cursorless-dev/cursorless-talon#94

Merged

pokey marked this pull request as ready for review October 17, 2021 17:34

pokey commented Oct 17, 2021

View reviewed changes

pokey requested a review from AndreasArvidsson October 17, 2021 17:57

pokey added 5 commits October 19, 2021 10:17

Initial working version

8dd40cf

Almost done

61fc7bc

Change languageId

357719e

Remove accidental file

180f374

Attempt at complex version

cfa46fc

pokey force-pushed the snippet-wrap branch 2 times, most recently from a0d5e21 to b492207 Compare October 19, 2021 16:55

pokey commented Oct 20, 2021

View reviewed changes

pokey added 3 commits October 21, 2021 14:20

Initial version using integer placeholders

df99a07

Working using names

a52473f

Fix tests

2a84b42

pokey force-pushed the snippet-wrap branch from 5fa05cf to 2a84b42 Compare October 21, 2021 13:51

pokey commented Oct 21, 2021

View reviewed changes

package.json Outdated

}

}

},

"cursorless.experimental.snippets": {

Copy link
Copy Markdown

Member Author

pokey Oct 21, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tagged the setting as experimental

pokey added 7 commits October 21, 2021 14:59

Fix tests

f411204

Fix schema

b9e1ac1

Fixes

90d5a5b

Fix python tests

8b86f10

Cleanup yaml formatting

7ccafc2

Support snippet overrides

1df155c

Fix inference

6388499

pokey added 12 commits October 21, 2021 16:23

Cleanup

b1a53e2

CI fix

2e9f7b1

Cleanup

58c5b83

Remove yarn-error.log

d741029

Update schema docs

30b8163

More dock

36035c6

Support user snippets dir

5722322

use json schema ref

3da4762

Fix schema

541fd3f

Wrap with snippet cleanup

07fdfcf

Cleanup

7205c61

More cleanup

1810d62

pokey commented Oct 23, 2021

View reviewed changes

pokey added 8 commits October 23, 2021 16:40

Change / to . for placeholder indication

45e4f82

Reformat

a0a190d

Fix comment

20a2717

Fix tests

f74bd50

Add basic docs

bac3d38

Change snippet format

7d716be

Fixes

a8926a5

Add description field

6adc0af

AndreasArvidsson approved these changes Oct 25, 2021

View reviewed changes

pokey merged commit 1633ac1 into main Oct 25, 2021

pokey deleted the snippet-wrap branch October 25, 2021 12:15

		@@ -0,0 +1,436 @@
		/*---------------------------------------------------------------------------------------------

Uh oh!

Conversation

pokey commented Oct 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pokey commented Oct 15, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pokey left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

pokey Oct 21, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

pokey commented Oct 15, 2021 •

edited

Loading

pokey commented Oct 15, 2021 •

edited

Loading

pokey Oct 21, 2021 •

edited

Loading