keyboard: Use parser for key sequences (#2051)

## Checklist

- [x] 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)
(keeping this somewhat under wraps while we experiment
- [x] I have not broken the cheatsheet
- [-] Refactor delete mapping to just issue token for delete action
- [x] Extract partial parameters
- [-] Add railroad to docs?

Author: pokey

.editorconfig

@@ -28,7 +28,7 @@ trim_trailing_whitespace = false
 [Makefile]
 indent_style = tab
 
-[**/vendor/**]
+[**/{vendor,generated}/**]
 charset = unset
 end_of_line = unset
 indent_size = unset

.eslintrc.json

@@ -78,5 +78,10 @@
       }
     }
   },
-  "ignorePatterns": ["**/vendor/**/*.ts", "**/vendor/**/*.js", "**/out/**"]
+  "ignorePatterns": [
+    "**/vendor/**/*.ts",
+    "**/vendor/**/*.js",
+    "**/out/**",
+    "**/generated/**"
+  ]
 }

.pre-commit-config.yaml

@@ -40,7 +40,7 @@ repos:
         # tests use strings with trailing white space to represent the final
         # document contents. For example
         # packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/languages/ruby/changeCondition.yml
-        exclude: ^packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/.*/[^/]*\.yml$
+        exclude: ^packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/.*/[^/]*\.yml$|/generated/|^patches/
   - repo: local
     hooks:
       - id: eslint

.prettierignore

@@ -1,4 +1,5 @@
 **/vendor
+**/generated
 
 # We use our own format for our recorded yaml tests to keep them compact
 /packages/cursorless-vscode-e2e/src/suite/fixtures/recorded/**/*.yml

.vscode/tasks.json

@@ -26,6 +26,7 @@
       "type": "npm",
       "script": "esbuild",
       "path": "packages/cursorless-vscode",
+      "dependsOn": ["Generate grammar"],
       "presentation": {
         "reveal": "silent"
       },
@@ -61,6 +62,16 @@
       },
       "group": "build"
     },
+    {
+      "label": "Generate grammar",
+      "type": "npm",
+      "script": "generate-grammar",
+      "path": "packages/cursorless-vscode",
+      "presentation": {
+        "reveal": "silent"
+      },
+      "group": "build"
+    },
     {
       "label": "Ensure test subset file exists",
       "type": "npm",

docs/user/experimental/keyboard/modal.md

@@ -42,7 +42,7 @@ The above allows you to press `ctrl-c` to switch to Cursorless mode, `escape` to
 To bind keys that do not have modifiers (eg just pressing `a`), add entries like the following to your [VSCode `settings.json`](https://code.visualstudio.com/docs/getstarted/settings#_settingsjson) (or edit these settings in the VSCode settings gui by saying `"cursorless settings"`):
 
 ```json
-  "cursorless.experimental.keyboard.modal.keybindings.scopes": {
+  "cursorless.experimental.keyboard.modal.keybindings.scope": {
     "i": "line",
     "p": "paragraph",
     ";": "statement",
@@ -60,7 +60,7 @@ To bind keys that do not have modifiers (eg just pressing `a`), add entries like
     "sa": "argumentOrParameter",
     "sl": "url",
   },
-  "cursorless.experimental.keyboard.modal.keybindings.actions": {
+  "cursorless.experimental.keyboard.modal.keybindings.action": {
     "t": "setSelection",
     "h": "setSelectionBefore",
     "l": "setSelectionAfter",
@@ -81,13 +81,13 @@ To bind keys that do not have modifiers (eg just pressing `a`), add entries like
     "ap": "pasteFromClipboard",
     "ad": "followLink"
   },
-  "cursorless.experimental.keyboard.modal.keybindings.colors": {
+  "cursorless.experimental.keyboard.modal.keybindings.color": {
     "d": "default",
     "b": "blue",
     "g": "yellow",
     "r": "red"
   },
-  "cursorless.experimental.keyboard.modal.keybindings.shapes": {
+  "cursorless.experimental.keyboard.modal.keybindings.shape": {
     "x": "ex",
     "f": "fox",
     "q": "frame",
@@ -97,7 +97,7 @@ To bind keys that do not have modifiers (eg just pressing `a`), add entries like
     "z": "bolt",
     "w": "crosshairs"
   },
-  "cursorless.experimental.keyboard.modal.keybindings.vscodeCommands": {
+  "cursorless.experimental.keyboard.modal.keybindings.vscodeCommand": {
     // For simple commands, just use the command name
     // "aa": "workbench.action.editor.changeLanguageMode",
 

package.json

@@ -44,7 +44,9 @@
   },
   "pnpm": {
     "patchedDependencies": {
-      "@docusaurus/theme-search-algolia@3.0.1": "patches/@docusaurus__theme-search-algolia@2.3.1.patch"
+      "@docusaurus/theme-search-algolia@3.0.1": "patches/@docusaurus__theme-search-algolia@2.3.1.patch",
+      "@types/nearley@2.11.5": "patches/@types__nearley@2.11.5.patch",
+      "nearley@2.20.1": "patches/nearley@2.20.1.patch"
     },
     "peerDependencyRules": {
       "ignoreMissing": [

packages/common/package.json

@@ -25,6 +25,7 @@
     "@types/mocha": "^10.0.3",
     "@types/sinon": "^10.0.2",
     "cross-spawn": "7.0.3",
+    "fast-check": "3.12.0",
     "js-yaml": "^4.1.0",
     "mocha": "^10.2.0",
     "sinon": "^11.1.1"

packages/common/src/index.ts

@@ -56,6 +56,7 @@ export * from "./types/GeneralizedRange";
 export * from "./types/RangeOffsets";
 export * from "./util/omitByDeep";
 export * from "./util/range";
+export * from "./util/uniqWithHash";
 export * from "./testUtil/isTesting";
 export * from "./testUtil/testConstants";
 export * from "./testUtil/getFixturePaths";

packages/common/src/util/CompositeKeyMap.ts

@@ -35,4 +35,9 @@ export class CompositeKeyMap<K, V> {
     delete this.map[this.hash(key)];
     return this;
   }
+
+  clear(): this {
+    this.map = {};
+    return this;
+  }
 }