fix(input/#3783): Part 1 - Add 'editorLangId' context key (#3794)

* Add entry about 'editorLangId' * Add editor lang id context key * Add some missing key bindings for language features to docs * Add CHANGES entry
onivim · Aug 22, 2021 · 07b08c9 · 07b08c9
1 parent faf06c1
commit 07b08c9
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 0 deletions.
diff --git a/CHANGES_CURRENT.md b/CHANGES_CURRENT.md
@@ -1,6 +1,7 @@
 ### Features 
 
 - #3795 - Search: Add `search.useIgnoreFiles` configuration setting (fixes #3792)
+- #3794 - Input: Add `editorLangId` context key (related #3783)
 
 ### Bug Fixes
 

diff --git a/docs/docs/configuration/key-bindings.md b/docs/docs/configuration/key-bindings.md
@@ -147,6 +147,9 @@ The `activeViewlet` context key corresponds to the id of the open sidebar pane:
 - `workbench.view.scm` - SCM
 - `workbench.view.search` - Search
 
+The `editorLangId` context key corresponds to the language identifier of the active editor (the same value shown in the statusbar), and can be combined with other context keys, like:
+`'when': 'editorFocus && editorLangId == typescript'`
+
 Onivim-specific contexts:
 
 | Context Name | True When | 
@@ -185,6 +188,14 @@ Onivim-specific contexts:
 | Control+V / Command+V | Paste from clipboard | `editor.action.clipboardPasteAction` |
 | Control+S / Command+S | Save file | `workbench.action.files.save`
 
+### Language Features
+
+| Default Key Binding | Description | Command |
+| --- | --- | --- |
+| F2 | Rename | `editor.action.rename` |
+| F12 or `gd` | Go-to Definition | `editor.action.revealDefinition` |
+| Shift+F12 | Go-to References | `editor.action.goToReferences` |
+
 ### List / Menu commands
 
 > NOTE: Some of the list select commands may not be fully hooked up yet, such that they may not respect vertical/horizontal opening.

diff --git a/src/Feature/Editor/Editor.re b/src/Feature/Editor/Editor.re
@@ -150,6 +150,20 @@ type t = {
   showDeprecated: bool,
 };
 
+module ContextKeys = {
+  open WhenExpr.ContextKeys.Schema;
+
+  let editorLangId =
+    string("editorLangId", ({buffer, _}) => {
+      EditorBuffer.fileType(buffer) |> Oni_Core.Buffer.FileType.toString
+    });
+};
+
+let contextKeys = editor => {
+  WhenExpr.ContextKeys.(
+    ContextKeys.[editorLangId] |> Schema.fromList |> fromSchema(editor)
+  );
+};
 let setBoundingBox = (bbox, editor) => {
   let (left, top, _, _) = Revery.Math.BoundingBox2d.getBounds(bbox);
   {...editor, pixelY: top, pixelX: left};

diff --git a/src/Feature/Editor/Editor.rei b/src/Feature/Editor/Editor.rei
@@ -34,6 +34,8 @@ let create:
   t;
 let copy: t => t;
 
+let contextKeys: t => WhenExpr.ContextKeys.t;
+
 type inlineElement;
 
 let setCodeLens:

diff --git a/src/Model/ContextKeys.re b/src/Model/ContextKeys.re
@@ -135,6 +135,11 @@ let all = (state: State.t) => {
     |> Schema.map(({sideBar, _}: State.t) => sideBar)
     |> fromSchema(state);
 
+  let editorContextKeys =
+    state.layout
+    |> Feature_Layout.activeEditor
+    |> Feature_Editor.Editor.contextKeys;
+
   // TODO: These sidebar-specific UI pieces should be encapsulated
   // by Feature_SideBar.contextKeys.
   let scmContextKeys =
@@ -190,6 +195,7 @@ let all = (state: State.t) => {
     explorerContextKeys,
     sideBarContext,
     scmContextKeys,
+    editorContextKeys,
     extensionContextKeys,
     searchContextKeys,
     paneContextKeys,