allow using Ctrl-C to copy in vim mode

Defaults to true for consistency with the jupyterlab-vim extension
jupyterlab · Oct 4, 2020 · ebab15c · ebab15c
1 parent a59f89a
commit ebab15c
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 3 deletions.
diff --git a/packages/codemirror-extension/schema/commands.json b/packages/codemirror-extension/schema/commands.json
@@ -57,6 +57,12 @@
       "title": "Block Comment on MacOS keyboard",
       "description": "Key command for block comment with MacOS",
       "default": "Cmd-/"
+    },
+    "vim:CtrlC-to-copy": {
+      "type": "boolean",
+      "title": "Ctrl-C Copies in Vim mode",
+      "description": "If true disable the default vim action for Ctrl-C to allow copying using the keyboard.",
+      "default": true
     }
   },
   "type": "object"

diff --git a/packages/codemirror-extension/src/index.ts b/packages/codemirror-extension/src/index.ts
@@ -192,6 +192,7 @@ function activateEditorCommands(
 
   let toggleComment = 'Ctrl-/';
   let toggleCommentMac = 'Cmd-/';
+  let vimDisableCtrlC = true;
   let removeKeymaps: IDisposable[] = [];
 
   /**
@@ -238,6 +239,9 @@ function activateEditorCommands(
     toggleCommentMac =
       (settings.get('toggleCommentMac').composite as string) ??
       toggleCommentMac;
+    vimDisableCtrlC =
+      (settings.get('vim:CtrlC-to-copy').composite as boolean) ??
+      vimDisableCtrlC;
   }
 
   /**
@@ -253,6 +257,9 @@ function activateEditorCommands(
     const extraKeys = editor.getOption('extraKeys') || {};
     extraKeys[toggleComment] = 'toggleComment';
     extraKeys[toggleCommentMac] = 'toggleComment';
+    if (vimDisableCtrlC && keyMap === 'vim') {
+      extraKeys['Ctrl-C'] = false;
+    }
     editor.setOption('extraKeys', extraKeys);
   }
 
@@ -307,8 +314,8 @@ function activateEditorCommands(
       // connect to signal here to ensure vim keymap has
       // been imported in case we need it
       /**
-      * Handle settings of Notebook cells
-      */
+       * Handle settings of Notebook cells
+       */
       notebookTracker.newCellCreated.connect((sender, cell) => {
         if (cell?.inputArea.editor instanceof CodeMirrorEditor) {
           setEditorOptions(cell.inputArea.editor);
@@ -321,7 +328,6 @@ function activateEditorCommands(
       updateNotebookTracker();
     });
 
-
   /**
    * A test for whether the tracker has an active widget.
    */