ep_vim 0.10.1 → 0.11.0

package/README.md

@@ -29,8 +29,6 @@ A vim-mode plugin for [Etherpad](https://etherpad.org/). Adds modal editing with
 
 ## Differences from vi
 
-- **Ctrl key mapping** — browser shortcuts conflict with common vim bindings (`Ctrl+d`, `Ctrl+u`, `Ctrl+r`, etc.); These will be implemented under a configurable setting.
-- **Clipboard toggle** — the default register writes to the system clipboard. We will add a setting to turn on the default vim behavior.
 - **No command line, macros, or globals** - these are not planned, but PRs welcome.
 
 ## Installation

package/ep.json

@@ -9,7 +9,8 @@
         "postToolbarInit": "ep_vim/static/js/index"
       },
       "hooks": {
-        "eejsBlock_editbarMenuLeft": "ep_vim/index"
+        "eejsBlock_editbarMenuLeft": "ep_vim/index",
+        "eejsBlock_mySettings": "ep_vim/index"
       }
     }
   ]

package/index.js

@@ -6,3 +6,8 @@ exports.eejsBlock_editbarMenuLeft = (hook, args, cb) => {
   args.content += eejs.require('ep_vim/templates/editbarButtons.ejs');
   return cb();
 };
+
+exports.eejsBlock_mySettings = (_hook, args, cb) => {
+  args.content += eejs.require('ep_vim/templates/settings.ejs');
+  return cb();
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ep_vim",
-  "version": "0.10.1",
+  "version": "0.11.0",
   "description": "Vim-mode plugin for Etherpad with modal editing, motions, and operators",
   "author": {
     "name": "Seth Rothschild",

package/static/js/index.js

@@ -30,6 +30,9 @@ let vimEnabled =
   typeof localStorage !== "undefined" &&
   localStorage.getItem("ep_vimEnabled") === "true";
 
+let useSystemClipboard = true;
+let useCtrlKeys = true;
+
 const state = {
   mode: "normal",
   pendingKey: null,
@@ -66,7 +69,7 @@ const setRegister = (value) => {
   }
   state.register = value;
   const text = Array.isArray(value) ? value.join("\n") + "\n" : value;
-  if (navigator.clipboard) {
+  if (useSystemClipboard && navigator.clipboard) {
     navigator.clipboard.writeText(text).catch(() => {});
   }
 };
@@ -1162,6 +1165,22 @@ exports.postToolbarInit = (_hookName, _args) => {
     localStorage.setItem("ep_vimEnabled", vimEnabled ? "true" : "false");
     btn.classList.toggle("vim-enabled", vimEnabled);
   });
+
+  const clipboardCheckbox = document.getElementById(
+    "options-vim-use-system-clipboard",
+  );
+  if (!clipboardCheckbox) return;
+  useSystemClipboard = clipboardCheckbox.checked;
+  clipboardCheckbox.addEventListener("change", () => {
+    useSystemClipboard = clipboardCheckbox.checked;
+  });
+
+  const ctrlKeysCheckbox = document.getElementById("options-vim-use-ctrl-keys");
+  if (!ctrlKeysCheckbox) return;
+  useCtrlKeys = ctrlKeysCheckbox.checked;
+  ctrlKeysCheckbox.addEventListener("change", () => {
+    useCtrlKeys = ctrlKeysCheckbox.checked;
+  });
 };
 
 exports.postAceInit = (_hookName, { ace }) => {
@@ -1181,7 +1200,10 @@ exports.aceKeyEvent = (_hookName, { evt, rep, editorInfo }) => {
 
   const isBrowserShortcut =
     (evt.ctrlKey || evt.metaKey) &&
-    (evt.key === "x" || evt.key === "c" || evt.key === "v" || evt.key === "r");
+    (evt.key === "x" ||
+      evt.key === "c" ||
+      evt.key === "v" ||
+      (evt.key === "r" && !useCtrlKeys));
   if (isBrowserShortcut) return false;
 
   state.currentRep = rep;
@@ -1247,6 +1269,51 @@ exports.aceKeyEvent = (_hookName, { evt, rep, editorInfo }) => {
       : rep.selStart;
   const lineText = rep.lines.atIndex(line).text;
   const ctx = { rep, editorInfo, line, char, lineText };
+
+  if (useCtrlKeys && evt.ctrlKey && state.mode === "normal") {
+    if (state.countBuffer !== "") {
+      state.pendingCount = parseInt(state.countBuffer, 10);
+      state.countBuffer = "";
+    }
+    const count = state.pendingCount !== null ? state.pendingCount : 1;
+
+    if (evt.key === "r") {
+      editorInfo.ace_doUndoRedo("redo");
+      state.pendingCount = null;
+      state.pendingRegister = null;
+      evt.preventDefault();
+      return true;
+    }
+
+    const halfPage = 15;
+    if (evt.key === "d") {
+      const target = Math.min(line + halfPage * count, rep.lines.length() - 1);
+      const targetLen = rep.lines.atIndex(target).text.length;
+      moveBlockCursor(
+        editorInfo,
+        target,
+        Math.min(char, Math.max(0, targetLen - 1)),
+      );
+      state.pendingCount = null;
+      state.pendingRegister = null;
+      evt.preventDefault();
+      return true;
+    }
+    if (evt.key === "u") {
+      const target = Math.max(line - halfPage * count, 0);
+      const targetLen = rep.lines.atIndex(target).text.length;
+      moveBlockCursor(
+        editorInfo,
+        target,
+        Math.min(char, Math.max(0, targetLen - 1)),
+      );
+      state.pendingCount = null;
+      state.pendingRegister = null;
+      evt.preventDefault();
+      return true;
+    }
+  }
+
   const handled = handleKey(evt.key, ctx);
   if (handled) evt.preventDefault();
   return handled;

package/templates/settings.ejs

@@ -0,0 +1,8 @@
+<p>
+  <input type="checkbox" id="options-vim-use-system-clipboard" checked></input>
+  <label for="options-vim-use-system-clipboard">Use system clipboard (vim)</label>
+</p>
+<p>
+  <input type="checkbox" id="options-vim-use-ctrl-keys" checked></input>
+  <label for="options-vim-use-ctrl-keys">Use Ctrl keys (vim)</label>
+</p>