ep_vim 0.11.0 → 0.12.1

package/README.md

@@ -16,16 +16,18 @@ A vim-mode plugin for [Etherpad](https://etherpad.org/). Adds modal editing with
 - **Bracket matching** — `%` jump to matching bracket
 - **Text objects** — `iw`/`aw` (word), `i"`/`a"` and `i'`/`a'` (quotes), `i{`/`a{` etc. (brackets), `ip`/`ap` (paragraph), `is`/`as` (sentence)
 - **Operators** — `d`, `c`, `y` with motion and text object combinations (`dw`, `ce`, `y$`, `ciw`, `da"`, `yi(`, etc.)
-- **Line operations** — `dd`, `cc`, `yy`, `J` (join), `Y` (yank line)
+- **Line operations** — `dd`, `cc`, `yy`, `D`, `J` (join), `Y` (yank line)
 - **Registers** — `"a`–`"z` named registers for yank/delete/put, `"_` blackhole register
 - **Put** — `p` / `P` with linewise and characterwise register handling
 - **Editing** — `i` `a` `A` `I` (insert/append), `x`, `r`, `s`, `S`, `C`, `o`, `O`, `~` (toggle case)
 - **Marks** — `m{a-z}` to set, `'{a-z}` / `` `{a-z} `` to jump
-- **Search** — `/` and `?` forward/backward, `n`/`N` repeat
+- **Search** — `/` and `?` forward/backward, `n`/`N` repeat, `*`/`#` search word under cursor
+- **Scrolling** — `zz`/`zt`/`zb` center/top/bottom, `Ctrl+d`/`Ctrl+u` half-page, `Ctrl+f`/`Ctrl+b` full-page (requires ctrl keys enabled)
+- **Visual** — `v` char, `V` line, `gv` reselect last selection; `~` toggle case in visual
 - **Repeat** — `.` repeat last command
 - **Counts** — numeric prefixes work with motions and operators
-- **Undo** — `u`
-- **Toggle** — toolbar button to enable/disable vim mode, persisted in localStorage
+- **Undo/redo** — `u` undo, `Ctrl+r` redo (requires ctrl keys enabled)
+- **Toggle** — toolbar button to enable/disable vim mode, persisted in localStorage; settings panel for system clipboard and ctrl key behavior
 
 ## Differences from vi
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ep_vim",
-  "version": "0.11.0",
+  "version": "0.12.1",
   "description": "Vim-mode plugin for Etherpad with modal editing, motions, and operators",
   "author": {
     "name": "Seth Rothschild",
@@ -24,14 +24,14 @@
   "peerDependencies": {
     "ep_etherpad-lite": ">=1.8.6"
   },
+  "scripts": {
+    "test": "npm run format && node --test static/js/vim-core.test.js static/js/index.test.js",
+    "format": "prettier -w static/js/*"
+  },
   "engines": {
     "node": ">=20.0.0"
   },
   "dependencies": {
     "prettier": "^3.8.1"
-  },
-  "scripts": {
-    "test": "npm run format && node --test static/js/vim-core.test.js static/js/index.test.js",
-    "format": "prettier -w static/js/*"
   }
-}
+}

package/static/js/index.js

@@ -54,6 +54,7 @@ const state = {
   searchBuffer: "",
   searchDirection: null,
   lastSearch: null,
+  lastVisualSelection: null,
 };
 
 // --- Editor operations ---
@@ -539,6 +540,8 @@ registerMotion("L", (ctx) => {
   };
 });
 
+// --- Char search motions ---
+
 registerParamMotion("f", (key, ctx) => {
   const pos = charSearchPos("f", ctx.lineText, ctx.char, key, ctx.count);
   return pos !== -1 ? pos : null;
@@ -767,24 +770,32 @@ commands["visual-line"]["~"] = (ctx) => {
   moveBlockCursor(ctx.editorInfo, start[0], start[1]);
 };
 
-// --- Miscellaneous ---
+commands["visual-char"]["i"] = () => {
+  state.pendingKey = "i";
+};
 
-commands.normal["u"] = ({ editorInfo }) => {
-  editorInfo.ace_doUndoRedo("undo");
+commands["visual-char"]["a"] = () => {
+  state.pendingKey = "a";
 };
 
-commands.normal["."] = (ctx) => {
-  if (!state.lastCommand) return;
-  const { key, count, param } = state.lastCommand;
-  if (param !== null && parameterized[key]) {
-    parameterized[key](param, ctx);
-  } else if (commands[state.mode] && commands[state.mode][key]) {
-    const newCtx = { ...ctx, count };
-    commands[state.mode][key](newCtx);
-  }
+commands["visual-line"]["i"] = () => {
+  state.pendingKey = "i";
+};
+
+commands["visual-line"]["a"] = () => {
+  state.pendingKey = "a";
 };
 
-// --- Mode transitions ---
+commands.normal["gv"] = ({ editorInfo, rep }) => {
+  if (!state.lastVisualSelection) return;
+  const { anchor, cursor, mode } = state.lastVisualSelection;
+  state.visualAnchor = anchor;
+  state.visualCursor = cursor;
+  state.mode = mode;
+  updateVisualSelection(editorInfo, rep);
+};
+
+// --- Insert mode entry ---
 
 commands.normal["i"] = ({ editorInfo, line, char }) => {
   clearEmptyLineCursor();
@@ -810,22 +821,6 @@ commands.normal["I"] = ({ editorInfo, line, lineText }) => {
   state.mode = "insert";
 };
 
-commands["visual-char"]["i"] = () => {
-  state.pendingKey = "i";
-};
-
-commands["visual-char"]["a"] = () => {
-  state.pendingKey = "a";
-};
-
-commands["visual-line"]["i"] = () => {
-  state.pendingKey = "i";
-};
-
-commands["visual-line"]["a"] = () => {
-  state.pendingKey = "a";
-};
-
 commands.normal["o"] = ({ editorInfo, line, lineText }) => {
   clearEmptyLineCursor();
   replaceRange(
@@ -845,7 +840,7 @@ commands.normal["O"] = ({ editorInfo, line }) => {
   state.mode = "insert";
 };
 
-// --- More normal mode commands ---
+// --- Editing commands ---
 
 commands.normal["r"] = () => {
   state.pendingKey = "r";
@@ -995,6 +990,27 @@ commands.normal["S"] = ({ editorInfo, line, lineText }) => {
   recordCommand("S", 1);
 };
 
+// --- Undo, redo, repeat ---
+
+commands.normal["u"] = ({ editorInfo }) => {
+  editorInfo.ace_doUndoRedo("undo");
+};
+
+commands.normal["<C-r>"] = ({ editorInfo }) => {
+  editorInfo.ace_doUndoRedo("redo");
+};
+
+commands.normal["."] = (ctx) => {
+  if (!state.lastCommand) return;
+  const { key, count, param } = state.lastCommand;
+  if (param !== null && parameterized[key]) {
+    parameterized[key](param, ctx);
+  } else if (commands[state.mode] && commands[state.mode][key]) {
+    const newCtx = { ...ctx, count };
+    commands[state.mode][key](newCtx);
+  }
+};
+
 // --- Search ---
 
 commands.normal["/"] = () => {
@@ -1050,12 +1066,69 @@ commands.normal["#"] = (ctx) => {
   if (pos) moveBlockCursor(ctx.editorInfo, pos[0], pos[1]);
 };
 
+// --- Scroll ---
+
 commands.normal["zz"] = ({ line }) => {
   if (!state.editorDoc) return;
   const lineDiv = state.editorDoc.body.querySelectorAll("div")[line];
   if (lineDiv) lineDiv.scrollIntoView({ block: "center" });
 };
 
+commands.normal["zt"] = ({ line }) => {
+  if (!state.editorDoc) return;
+  const lineDiv = state.editorDoc.body.querySelectorAll("div")[line];
+  if (lineDiv) lineDiv.scrollIntoView({ block: "start" });
+};
+
+commands.normal["zb"] = ({ line }) => {
+  if (!state.editorDoc) return;
+  const lineDiv = state.editorDoc.body.querySelectorAll("div")[line];
+  if (lineDiv) lineDiv.scrollIntoView({ block: "end" });
+};
+
+const halfPage = 15;
+const fullPage = halfPage * 2;
+
+commands.normal["<C-d>"] = ({ editorInfo, rep, line, char, count }) => {
+  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)),
+  );
+};
+
+commands.normal["<C-u>"] = ({ editorInfo, rep, line, char, count }) => {
+  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)),
+  );
+};
+
+commands.normal["<C-f>"] = ({ editorInfo, rep, line, char, count }) => {
+  const target = Math.min(line + fullPage * count, rep.lines.length() - 1);
+  const targetLen = rep.lines.atIndex(target).text.length;
+  moveBlockCursor(
+    editorInfo,
+    target,
+    Math.min(char, Math.max(0, targetLen - 1)),
+  );
+};
+
+commands.normal["<C-b>"] = ({ editorInfo, rep, line, char, count }) => {
+  const target = Math.max(line - fullPage * count, 0);
+  const targetLen = rep.lines.atIndex(target).text.length;
+  moveBlockCursor(
+    editorInfo,
+    target,
+    Math.min(char, Math.max(0, targetLen - 1)),
+  );
+};
+
 // --- Dispatch ---
 
 const handleKey = (key, ctx) => {
@@ -1212,10 +1285,20 @@ exports.aceKeyEvent = (_hookName, { evt, rep, editorInfo }) => {
   if (evt.key === "Escape") {
     state.desiredColumn = null;
     if (state.mode === "visual-line") {
+      state.lastVisualSelection = {
+        anchor: state.visualAnchor,
+        cursor: state.visualCursor,
+        mode: "visual-line",
+      };
       const line = Math.min(state.visualAnchor[0], state.visualCursor[0]);
       state.mode = "normal";
       moveBlockCursor(editorInfo, line, 0);
     } else if (state.mode === "visual-char") {
+      state.lastVisualSelection = {
+        anchor: state.visualAnchor,
+        cursor: state.visualCursor,
+        mode: "visual-char",
+      };
       const [vLine, vChar] = state.visualCursor;
       state.mode = "normal";
       moveBlockCursor(editorInfo, vLine, vChar);
@@ -1271,44 +1354,9 @@ exports.aceKeyEvent = (_hookName, { evt, rep, editorInfo }) => {
   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;
+    const ctrlKey = "<C-" + evt.key + ">";
+    if (commands.normal[ctrlKey]) {
+      handleKey(ctrlKey, ctx);
       evt.preventDefault();
       return true;
     }
@@ -1324,3 +1372,9 @@ exports._state = state;
 exports._handleKey = handleKey;
 exports._commands = commands;
 exports._parameterized = parameterized;
+exports._setVimEnabled = (v) => {
+  vimEnabled = v;
+};
+exports._setUseCtrlKeys = (v) => {
+  useCtrlKeys = v;
+};

package/static/js/index.test.js

@@ -15,6 +15,9 @@ const {
   _handleKey: handleKey,
   _commands: commands,
   _parameterized: parameterized,
+  _setVimEnabled: setVimEnabled,
+  _setUseCtrlKeys: setUseCtrlKeys,
+  aceKeyEvent,
 } = require("./index.js");
 
 const makeRep = (lines) => ({
@@ -2022,6 +2025,7 @@ const resetState = () => {
   state.searchBuffer = "";
   state.searchDirection = null;
   state.lastSearch = null;
+  state.lastVisualSelection = null;
 };
 
 describe("edge cases: cc with count", () => {
@@ -3730,3 +3734,290 @@ describe("missing feature: zz center screen", () => {
     assert.doesNotThrow(() => commands.normal["zz"](ctx));
   });
 });
+
+describe("zt and zb scroll commands", () => {
+  beforeEach(resetState);
+
+  it("zt does nothing when editorDoc is null", () => {
+    state.editorDoc = null;
+    const rep = makeRep(["hello"]);
+    const { editorInfo } = makeMockEditorInfo();
+    const ctx = {
+      rep,
+      editorInfo,
+      line: 0,
+      char: 0,
+      lineText: "hello",
+      count: 1,
+      hasCount: false,
+    };
+    assert.doesNotThrow(() => commands.normal["zt"](ctx));
+  });
+
+  it("zb does nothing when editorDoc is null", () => {
+    state.editorDoc = null;
+    const rep = makeRep(["hello"]);
+    const { editorInfo } = makeMockEditorInfo();
+    const ctx = {
+      rep,
+      editorInfo,
+      line: 0,
+      char: 0,
+      lineText: "hello",
+      count: 1,
+      hasCount: false,
+    };
+    assert.doesNotThrow(() => commands.normal["zb"](ctx));
+  });
+
+  it("zt calls scrollIntoView with block: start", () => {
+    const scrollCalls = [];
+    const mockLineDiv = {
+      scrollIntoView: (opts) => scrollCalls.push(opts),
+    };
+    state.editorDoc = {
+      body: {
+        querySelectorAll: () => [mockLineDiv],
+      },
+    };
+    const rep = makeRep(["hello"]);
+    const { editorInfo } = makeMockEditorInfo();
+    const ctx = {
+      rep,
+      editorInfo,
+      line: 0,
+      char: 0,
+      lineText: "hello",
+      count: 1,
+      hasCount: false,
+    };
+    commands.normal["zt"](ctx);
+    assert.equal(scrollCalls.length, 1);
+    assert.deepEqual(scrollCalls[0], { block: "start" });
+  });
+
+  it("zb calls scrollIntoView with block: end", () => {
+    const scrollCalls = [];
+    const mockLineDiv = {
+      scrollIntoView: (opts) => scrollCalls.push(opts),
+    };
+    state.editorDoc = {
+      body: {
+        querySelectorAll: () => [mockLineDiv],
+      },
+    };
+    const rep = makeRep(["hello"]);
+    const { editorInfo } = makeMockEditorInfo();
+    const ctx = {
+      rep,
+      editorInfo,
+      line: 0,
+      char: 0,
+      lineText: "hello",
+      count: 1,
+      hasCount: false,
+    };
+    commands.normal["zb"](ctx);
+    assert.equal(scrollCalls.length, 1);
+    assert.deepEqual(scrollCalls[0], { block: "end" });
+  });
+});
+
+describe("gv reselect last visual", () => {
+  beforeEach(resetState);
+
+  it("does nothing when lastVisualSelection is null", () => {
+    state.lastVisualSelection = null;
+    const rep = makeRep(["hello world"]);
+    const { editorInfo, calls } = makeMockEditorInfo();
+    const ctx = {
+      rep,
+      editorInfo,
+      line: 0,
+      char: 0,
+      lineText: "hello world",
+      count: 1,
+      hasCount: false,
+    };
+    commands.normal["gv"](ctx);
+    assert.equal(calls.length, 0);
+    assert.equal(state.mode, "normal");
+  });
+
+  it("restores visual-char selection", () => {
+    state.lastVisualSelection = {
+      anchor: [0, 2],
+      cursor: [0, 5],
+      mode: "visual-char",
+    };
+    const rep = makeRep(["hello world"]);
+    const { editorInfo, calls } = makeMockEditorInfo();
+    const ctx = {
+      rep,
+      editorInfo,
+      line: 0,
+      char: 0,
+      lineText: "hello world",
+      count: 1,
+      hasCount: false,
+    };
+    commands.normal["gv"](ctx);
+    assert.equal(state.mode, "visual-char");
+    assert.deepEqual(state.visualAnchor, [0, 2]);
+    assert.deepEqual(state.visualCursor, [0, 5]);
+    assert.ok(calls.length > 0, "expected a selection call");
+  });
+
+  it("restores visual-line selection", () => {
+    state.lastVisualSelection = {
+      anchor: [1, 0],
+      cursor: [2, 0],
+      mode: "visual-line",
+    };
+    const rep = makeRep(["aaa", "bbb", "ccc"]);
+    const { editorInfo } = makeMockEditorInfo();
+    const ctx = {
+      rep,
+      editorInfo,
+      line: 0,
+      char: 0,
+      lineText: "aaa",
+      count: 1,
+      hasCount: false,
+    };
+    commands.normal["gv"](ctx);
+    assert.equal(state.mode, "visual-line");
+    assert.deepEqual(state.visualAnchor, [1, 0]);
+    assert.deepEqual(state.visualCursor, [2, 0]);
+  });
+
+  it("escape from visual-char saves lastVisualSelection", () => {
+    state.mode = "visual-char";
+    state.visualAnchor = [0, 1];
+    state.visualCursor = [0, 4];
+    state.editorDoc = null;
+    const rep = makeRep(["hello world"]);
+    rep.selStart = [0, 4];
+    const { editorInfo } = makeMockEditorInfo();
+    const mockEvt = {
+      type: "keydown",
+      key: "Escape",
+      ctrlKey: false,
+      metaKey: false,
+      target: { ownerDocument: null },
+      preventDefault: () => {},
+    };
+    setVimEnabled(true);
+    aceKeyEvent("aceKeyEvent", { evt: mockEvt, rep, editorInfo });
+    setVimEnabled(false);
+    assert.deepEqual(state.lastVisualSelection, {
+      anchor: [0, 1],
+      cursor: [0, 4],
+      mode: "visual-char",
+    });
+  });
+
+  it("escape from visual-line saves lastVisualSelection", () => {
+    state.mode = "visual-line";
+    state.visualAnchor = [0, 0];
+    state.visualCursor = [2, 0];
+    state.editorDoc = null;
+    const rep = makeRep(["aaa", "bbb", "ccc"]);
+    rep.selStart = [2, 0];
+    const { editorInfo } = makeMockEditorInfo();
+    const mockEvt = {
+      type: "keydown",
+      key: "Escape",
+      ctrlKey: false,
+      metaKey: false,
+      target: { ownerDocument: null },
+      preventDefault: () => {},
+    };
+    setVimEnabled(true);
+    aceKeyEvent("aceKeyEvent", { evt: mockEvt, rep, editorInfo });
+    setVimEnabled(false);
+    assert.deepEqual(state.lastVisualSelection, {
+      anchor: [0, 0],
+      cursor: [2, 0],
+      mode: "visual-line",
+    });
+  });
+});
+
+describe("Ctrl+f and Ctrl+b page scroll", () => {
+  beforeEach(() => {
+    resetState();
+    setVimEnabled(true);
+    setUseCtrlKeys(true);
+  });
+
+  const makeCtrlEvt = (key) => ({
+    type: "keydown",
+    key,
+    ctrlKey: true,
+    metaKey: false,
+    target: { ownerDocument: null },
+    preventDefault: () => {},
+  });
+
+  it("Ctrl+f moves forward one full page", () => {
+    const lines = Array.from({ length: 50 }, (_, i) => `line${i}`);
+    const rep = makeRep(lines);
+    rep.selStart = [0, 0];
+    const { editorInfo, calls } = makeMockEditorInfo();
+    aceKeyEvent("aceKeyEvent", {
+      evt: makeCtrlEvt("f"),
+      rep,
+      editorInfo,
+    });
+    const selectCall = calls.find((c) => c.type === "select");
+    assert.ok(selectCall, "expected a select call");
+    assert.equal(selectCall.start[0], 30);
+  });
+
+  it("Ctrl+b moves backward one full page", () => {
+    const lines = Array.from({ length: 50 }, (_, i) => `line${i}`);
+    const rep = makeRep(lines);
+    rep.selStart = [40, 0];
+    state.mode = "normal";
+    const { editorInfo, calls } = makeMockEditorInfo();
+    aceKeyEvent("aceKeyEvent", {
+      evt: makeCtrlEvt("b"),
+      rep,
+      editorInfo,
+    });
+    const selectCall = calls.find((c) => c.type === "select");
+    assert.ok(selectCall, "expected a select call");
+    assert.equal(selectCall.start[0], 10);
+  });
+
+  it("Ctrl+f clamps at end of document", () => {
+    const lines = Array.from({ length: 10 }, (_, i) => `line${i}`);
+    const rep = makeRep(lines);
+    rep.selStart = [5, 0];
+    const { editorInfo, calls } = makeMockEditorInfo();
+    aceKeyEvent("aceKeyEvent", {
+      evt: makeCtrlEvt("f"),
+      rep,
+      editorInfo,
+    });
+    const selectCall = calls.find((c) => c.type === "select");
+    assert.ok(selectCall, "expected a select call");
+    assert.equal(selectCall.start[0], 9);
+  });
+
+  it("Ctrl+b clamps at start of document", () => {
+    const lines = Array.from({ length: 10 }, (_, i) => `line${i}`);
+    const rep = makeRep(lines);
+    rep.selStart = [3, 0];
+    const { editorInfo, calls } = makeMockEditorInfo();
+    aceKeyEvent("aceKeyEvent", {
+      evt: makeCtrlEvt("b"),
+      rep,
+      editorInfo,
+    });
+    const selectCall = calls.find((c) => c.type === "select");
+    assert.ok(selectCall, "expected a select call");
+    assert.equal(selectCall.start[0], 0);
+  });
+});