Skip to content

fix: generate complete command descriptions in vimsplain README table #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
oller merged 2 commits into from
Mar 17, 2026
Merged

fix: generate complete command descriptions in vimsplain README table #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c3792d
fix: generate complete command descriptions in vimsplain README table
oller Mar 17, 2026
badd9dd
docs: add link to README
oller Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/curly-tables-jump.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"vimsplain": patch
---

fix: handle nested quotes in command descriptions for README generation

2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ pnpm dev # Start development server

## vimsplain

Parse and explain Vim keystroke sequences. Available as a standalone npm package.
Parse and explain Vim keystroke sequences. Available as a standalone [npm package](https://www.npmjs.com/package/vimsplain).

```ts
import { explainSequence, summarizeSequence } from "vimsplain";
Expand Down
84 changes: 42 additions & 42 deletions packages/vimsplain/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,10 +160,10 @@ SPECIAL_KEYS.CTRL_I // "[C-i]"
| `"\+yy` | yank line to system clipboard |
| `"\+p` | paste from system clipboard after cursor |
| `"\+P` | paste from system clipboard before cursor |
| `"(a)yy` | yank line into register |
| `"(a)dd` | delete line into register |
| `"(a)p` | paste from register |
| `"(a)P` | paste from register |
| `"(a)yy` | yank line into register '$1' |
| `"(a)dd` | delete line into register '$1' |
| `"(a)p` | paste from register '$1' after cursor |
| `"(a)P` | paste from register '$1' before cursor |
| `d$` | delete to end of line |
| `d0` | delete to start of line |
| `d^` | delete to first non-blank |
Expand All @@ -174,10 +174,10 @@ SPECIAL_KEYS.CTRL_I // "[C-i]"
| `dNe` | delete to end of $1 word(s) |
| `dNj` | delete $1 line(s) down |
| `dNk` | delete $1 line(s) up |
| `df(.)` | delete through |
| `dF(.)` | delete back through |
| `dt(.)` | delete till |
| `dT(.)` | delete back till |
| `df(.)` | delete through '$1' |
| `dF(.)` | delete back through '$1' |
| `dt(.)` | delete till '$1' |
| `dT(.)` | delete back till '$1' |
| `dd` | delete line |
| `Ndd` | delete $1 lines |
| `D` | delete to end of line |
Expand All @@ -187,10 +187,10 @@ SPECIAL_KEYS.CTRL_I // "[C-i]"
| `cNw` | change $1 word(s) forward |
| `cNb` | change $1 word(s) backward |
| `cNe` | change to end of $1 word(s) |
| `cf(.)` | change through |
| `cF(.)` | change back through |
| `ct(.)` | change till |
| `cT(.)` | change back till |
| `cf(.)` | change through '$1' |
| `cF(.)` | change back through '$1' |
| `ct(.)` | change till '$1' |
| `cT(.)` | change back till '$1' |
| `cc` | change entire line |
| `C` | change to end of line |
| `S` | substitute entire line |
Expand All @@ -199,19 +199,19 @@ SPECIAL_KEYS.CTRL_I // "[C-i]"
| `y0` | yank to start of line |
| `y^` | yank to first non-blank |
| `yNw` | yank $1 word(s) forward |
| `yf(.)` | yank through |
| `yF(.)` | yank back through |
| `yt(.)` | yank till |
| `yT(.)` | yank back till |
| `yf(.)` | yank through '$1' |
| `yF(.)` | yank back through '$1' |
| `yt(.)` | yank till '$1' |
| `yT(.)` | yank back till '$1' |
| `yy` | yank line |
| `Y` | yank line |
| `Nyy` | yank $1 lines |
| `ciw` | change inner word |
| `caw` | change a word (with space) |
| `ci"` | change inside |
| `ca"` | change around |
| `ci'` | change inside |
| `ca'` | change around |
| `ci"` | change inside "" |
| `ca"` | change around "" |
| `ci'` | change inside '' |
| `ca'` | change around '' |
| `ci(` | change inside () |
| `ci)` | change inside () |
| `ca(` | change around () |
Expand All @@ -228,10 +228,10 @@ SPECIAL_KEYS.CTRL_I // "[C-i]"
| `cat` | change around tag |
| `diw` | delete inner word |
| `daw` | delete a word (with space) |
| `di"` | delete inside |
| `da"` | delete around |
| `di'` | delete inside |
| `da'` | delete around |
| `di"` | delete inside "" |
| `da"` | delete around "" |
| `di'` | delete inside '' |
| `da'` | delete around '' |
| `di(` | delete inside () |
| `di)` | delete inside () |
| `da(` | delete around () |
Expand All @@ -248,20 +248,20 @@ SPECIAL_KEYS.CTRL_I // "[C-i]"
| `dat` | delete around tag |
| `yiw` | yank inner word |
| `yaw` | yank a word (with space) |
| `yi"` | yank inside |
| `ya"` | yank around |
| `yi'` | yank inside |
| `ya'` | yank around |
| `yi"` | yank inside "" |
| `ya"` | yank around "" |
| `yi'` | yank inside '' |
| `ya'` | yank around '' |
| `yi(` | yank inside () |
| `yi)` | yank inside () |
| `ya(` | yank around () |
| `ya)` | yank around () |
| `viw` | select inner word |
| `vaw` | select a word (with space) |
| `vi"` | select inside |
| `va"` | select around |
| `vi'` | select inside |
| `va'` | select around |
| `vi"` | select inside "" |
| `va"` | select around "" |
| `vi'` | select inside '' |
| `va'` | select around '' |
| `vi(` | select inside () |
| `va(` | select around () |
| `vi)` | select inside () |
Expand Down Expand Up @@ -300,10 +300,10 @@ SPECIAL_KEYS.CTRL_I // "[C-i]"
| `ya`` | yank around `` |
| `vi`` | select inside `` |
| `va`` | select around `` |
| `f(.)` | find |
| `F(.)` | find |
| `t(.)` | till |
| `T(.)` | till |
| `f(.)` | find '$1' forward |
| `F(.)` | find '$1' backward |
| `t(.)` | till '$1' forward |
| `T(.)` | till '$1' backward |
| `;` | repeat last f/t/F/T |
| `,` | repeat last f/t/F/T reverse |
| `Nw` | move $1 words forward |
Expand Down Expand Up @@ -349,7 +349,7 @@ SPECIAL_KEYS.CTRL_I // "[C-i]"
| `Nx` | delete $1 chars |
| `x` | delete char under cursor |
| `X` | delete char before cursor |
| `r(.)` | replace with |
| `r(.)` | replace with '$1' |
| `R` | enter replace mode |
| `~` | toggle case |
| `J` | join lines |
Expand All @@ -363,13 +363,13 @@ SPECIAL_KEYS.CTRL_I // "[C-i]"
| `v` | enter visual mode |
| `V` | enter visual line mode |
| `[C-v]` | enter visual block mode |
| `m(.)` | set mark |
| `'(.)` | go to mark |
| ``(.)` | go to mark |
| `q(a)` | start recording macro |
| `m(.)` | set mark '$1' |
| `'(.)` | go to mark '$1' (line) |
| ``(.)` | go to mark '$1' (exact) |
| `q(a)` | start recording macro '$1' |
| `q` | stop recording macro |
| `@@` | replay last macro |
| `@(a)` | play macro |
| `@(a)` | play macro '$1' |
| `n` | next search match |
| `N` | previous search match |
| `\*` | search word under cursor forward |
Expand Down
4 changes: 2 additions & 2 deletions packages/vimsplain/scripts/gen-commands-table.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ const block = normalCommandsMatch[0];
const entries: Array<{ keystroke: string; description: string }> = [];
const entriesRaw = [
...block.matchAll(
/\{[^}]*pattern:\s*\/\^?([^/]+)\/[^}]*description:\s*['"]([^'"]+)['"]/gs,
/\{[^}]*pattern:\s*\/\^?([^/]+)\/[^}]*description:\s*(["'])(.*?)\2/gs,
),
];

for (const match of entriesRaw) {
const rawPattern = match[1];
const description = match[2];
const description = match[3];

// Clean up the pattern for display
let keystroke = rawPattern
Expand Down
Loading