TriliumNext·TriliumNext/Trilium/.claude/skills/developing-vim-mode/SKILL.md

developing-vim-mode

Skill39k starsChanged 25 days agoAGPL-3.0View on GitHub

Use when changing, debugging or reviewing Vim mode in text notes: anything under `packages/ckeditor5/src/plugins/vim/` (the `TriliumVim` plugin, `VimSession`, `VimAdapter`, `LineIndex`, the Trilium commands on the `@replit/codemirror-vim-core` engine), its client side (`text/vim_mode.ts`, `layout/VimStatus.tsx`, `vim_key_reference.tsx`, the `textNoteVim*` and `vimModeHint*` options, the `#vimMode` label), or a key, motion, operator, text object, Ex command, `:ck` argument, mapping, register, macro, key hint or completion row to add or fix. Use it for reports such as "dd deleted the table", "the cursor jumped", "undo takes seconds", "the selection stays after Esc" or "the mode is stuck". Load it too before adding or changing a block, widget, container or collapsible structure in the text editor, because Vim mode reads every structure as lines and a new one needs a line rule and specs, and before upgrading the Vim engine or CKEditor. Use it as well to test Vim mode in the running app: a live probe, a regression hunt, or a full simulation round before a release ("run the Vim simulation", "sweep Vim mode", "fuzz it", "test Vim on a large note"). Covers the line model, how a key travels, the rules the engine imposes and its quirks that must stay worked around, undo steps and the cost of large changes, behavior that is decided and looks like a bug, checklists for each kind of addition, the spec kit and its traps, and the method and full plan of a live simulation. Includes live.mjs, which types Vim keys into a running instance with every write held, simulate.mjs, which sweeps every command over every kind of line, runs random sessions, reduces a failing one and times whole-note commands, and fixture.html, a note with every structure; don't write new ones.