@arthony/keybook 0.3.2 → 0.4.1

package/README.md

@@ -42,8 +42,9 @@ keybook check    # validate your data files
 In the TUI: type to fuzzy-search, ↑/↓ to move, ⏎ to copy the shortcut (or a
 recipe's command) to the clipboard, ⎋ to quit.
 
-Press `⌃O` in the TUI to add an entry without leaving the search screen. Or
-script it: `keybook add --app Fork --action 'Push' --keys 'shift cmd p' --tags push`
+Manage entries without leaving the search screen: `⌃O` to add, `⌃E` to edit the
+selected entry (pre-filled form), `⌃X` to delete it (with a `y/n` confirm). Or
+script an add: `keybook add --app Fork --action 'Push' --keys 'shift cmd p' --tags push`
 (`--keys` accepts glyphs or words; recipes use repeatable `--step`).
 
 ## Your data

package/dist/cli.js

@@ -7,7 +7,7 @@ import { Command } from "commander";
 import { Box, Text, render, useApp, useInput, useStdout } from "ink";
 import { createElement, useCallback, useMemo, useState } from "react";
 import { homedir } from "node:os";
-import { Document, parse, parseDocument } from "yaml";
+import { Document, isMap, isSeq, parse, parseDocument } from "yaml";
 import { z } from "zod";
 import { Fragment, jsx, jsxs } from "react/jsx-runtime";
 import { Fzf, extendedMatch } from "fzf";
@@ -177,6 +177,8 @@ function loadEntries(dataDir) {
 			}
 			entries.push({
 				app,
+				file,
+				index: i,
 				...parsed.data
 			});
 		});
@@ -310,6 +312,73 @@ function addEntry(dir, app, entry) {
 		lines: [`✓ ${created ? "created" : "added to"} ${basename(file)}`]
 	};
 }
+function deleteEntry(dir, file, index, expectedAction) {
+	const path = join(dir, file);
+	let original;
+	try {
+		original = readFileSync(path, "utf8");
+	} catch (e) {
+		return err(path, [e.message]);
+	}
+	const doc = parseDocument(original);
+	const node = doc.getIn(["entries", index]);
+	if ((isMap(node) ? String(node.get("action") ?? "").trim() : void 0) !== expectedAction.trim()) return err(path, ["✗ entry changed on disk — reload and retry"]);
+	doc.deleteIn(["entries", index]);
+	const seq = doc.getIn(["entries"]);
+	const emptied = isSeq(seq) ? seq.items.length === 0 : true;
+	try {
+		if (emptied) unlinkSync(path);
+		else writeFileSync(path, doc.toString());
+	} catch (e) {
+		return err(path, [e.message]);
+	}
+	if (!emptied) {
+		const fileErr = loadEntries(dir).errors.find((e) => e.file === basename(file));
+		if (fileErr) {
+			writeFileSync(path, original);
+			return err(path, [`✗ ${fileErr.message}`]);
+		}
+	}
+	return {
+		ok: true,
+		file: path,
+		created: false,
+		lines: [emptied ? `✗ deleted '${expectedAction}' (removed empty ${basename(file)})` : `✗ deleted '${expectedAction}'`]
+	};
+}
+function editEntry(dir, file, index, entry, expectedAction) {
+	if ("app" in entry) return err("", ["Error: entry must not have an app field; use --app instead"]);
+	const parsed = entrySchema.safeParse(entry);
+	if (!parsed.success) return err("", parsed.error.issues.map((i) => i.message));
+	const clean = buildClean(parsed.data);
+	const path = join(dir, file);
+	let original;
+	try {
+		original = readFileSync(path, "utf8");
+	} catch (e) {
+		return err(path, [e.message]);
+	}
+	const doc = parseDocument(original);
+	const node = doc.getIn(["entries", index]);
+	if ((isMap(node) ? String(node.get("action") ?? "").trim() : void 0) !== expectedAction.trim()) return err(path, ["✗ entry changed on disk — reload and retry"]);
+	doc.setIn(["entries", index], doc.createNode(clean));
+	try {
+		writeFileSync(path, doc.toString());
+	} catch (e) {
+		return err(path, [e.message]);
+	}
+	const fileErr = loadEntries(dir).errors.find((e) => e.file === basename(file));
+	if (fileErr) {
+		writeFileSync(path, original);
+		return err(path, [`✗ ${fileErr.message}`]);
+	}
+	return {
+		ok: true,
+		file: path,
+		created: false,
+		lines: [`✓ updated '${clean.action}'`]
+	};
+}
 //#endregion
 //#region src/commands.ts
 function runPath(env = process.env) {
@@ -390,7 +459,7 @@ function Field({ label, value, focused }) {
 		}) : null
 	] });
 }
-function FormFields({ draft, apps, appIndex, focused, existingTags }) {
+function FormFields({ draft, apps, appIndex, focused, existingTags, lockedApp }) {
 	const appChoices = [...apps, "Create new app…"];
 	return /* @__PURE__ */ jsxs(Box, {
 		flexDirection: "column",
@@ -398,7 +467,10 @@ function FormFields({ draft, apps, appIndex, focused, existingTags }) {
 			/* @__PURE__ */ jsxs(Box, { children: [/* @__PURE__ */ jsx(Text, {
 				color: focused === 0 ? "cyan" : "gray",
 				children: "App".padEnd(8)
-			}), draft.creatingApp ? /* @__PURE__ */ jsxs(Fragment, { children: [/* @__PURE__ */ jsx(Text, { children: draft.newApp }), focused === 0 ? /* @__PURE__ */ jsx(Text, {
+			}), lockedApp ? /* @__PURE__ */ jsx(Text, {
+				color: "gray",
+				children: `${lockedApp}  (locked)`
+			}) : draft.creatingApp ? /* @__PURE__ */ jsxs(Fragment, { children: [/* @__PURE__ */ jsx(Text, { children: draft.newApp }), focused === 0 ? /* @__PURE__ */ jsx(Text, {
 				inverse: true,
 				children: " "
 			}) : null] }) : /* @__PURE__ */ jsxs(Text, { children: [appChoices[appIndex] ?? "—", focused === 0 ? "  (↑/↓)" : ""] })] }),
@@ -617,10 +689,25 @@ function draftToEntryInput(d) {
 	if (d.notes.trim()) e.notes = d.notes.trim();
 	return e;
 }
-function useAddForm(initialApp = "") {
+/** Inverse of draftToEntryInput: seed a Draft from an existing entry for editing. */
+function entryToDraft(app, e) {
+	const type = e.keys ? "shortcut" : e.command ? "command" : "recipe";
+	return {
+		...emptyDraft,
+		app,
+		type,
+		action: e.action,
+		keys: e.keys ?? "",
+		command: e.command ?? "",
+		steps: e.steps ? [...e.steps] : [],
+		tags: (e.tags ?? []).join(", "),
+		notes: e.notes ?? ""
+	};
+}
+function useAddForm(initial = {}) {
 	const [draft, setDraft] = useState(() => ({
 		...emptyDraft,
-		app: initialApp
+		...initial
 	}));
 	const update = (patch) => setDraft((d) => ({
 		...d,
@@ -640,9 +727,9 @@ const TYPES = [
 	"recipe"
 ];
 const LAST_FIELD = 5;
-function AddEntryForm({ apps, existingTags, onSubmit, onComplete, onCancel, resolveTarget }) {
-	const { draft, update, setDraft } = useAddForm(apps[0] ?? "");
-	const [focused, setFocused] = useState(0);
+function AddEntryForm({ apps, existingTags, onSubmit, onComplete, onCancel, resolveTarget, initial, lockedApp, title }) {
+	const { draft, update, setDraft } = useAddForm(initial ?? { app: apps[0] ?? "" });
+	const [focused, setFocused] = useState(lockedApp ? 1 : 0);
 	const [appIndex, setAppIndex] = useState(0);
 	const [screen, setScreen] = useState("form");
 	const [hint, setHint] = useState("");
@@ -682,7 +769,7 @@ function AddEntryForm({ apps, existingTags, onSubmit, onComplete, onCancel, reso
 		}
 		if (key.escape) return onCancel();
 		if (key.ctrl && input === "n") return setFocused((f) => Math.min(f + 1, LAST_FIELD));
-		if (key.ctrl && input === "p") return setFocused((f) => Math.max(f - 1, 0));
+		if (key.ctrl && input === "p") return setFocused((f) => Math.max(f - 1, lockedApp ? 1 : 0));
 		if (focused === 0) {
 			if (key.upArrow) {
 				const next = Math.max(appIndex - 1, 0);
@@ -708,7 +795,7 @@ function AddEntryForm({ apps, existingTags, onSubmit, onComplete, onCancel, reso
 				const idx = TYPES.indexOf(draft.type);
 				return update({ type: TYPES[key.leftArrow ? (idx + TYPES.length - 1) % TYPES.length : (idx + 1) % TYPES.length] });
 			}
-			if (key.return) return goReview();
+			if (key.return) return setFocused(2);
 			return;
 		}
 		if (focused === 3 && draft.type === "recipe") {
@@ -731,6 +818,7 @@ function AddEntryForm({ apps, existingTags, onSubmit, onComplete, onCancel, reso
 		if (key.backspace || key.delete) return update({ [fieldKey]: draft[fieldKey].slice(0, -1) });
 		if (input && !key.ctrl && !key.meta) return update({ [fieldKey]: draft[fieldKey] + input });
 	});
+	const enterHint = focused <= 1 ? "next" : focused === 3 && draft.type === "recipe" ? "add step" : "review";
 	if (screen === "review") return /* @__PURE__ */ jsx(ReviewScreen, {
 		app: resolvedApp(review),
 		entry: draftToEntryInput(review),
@@ -742,7 +830,7 @@ function AddEntryForm({ apps, existingTags, onSubmit, onComplete, onCancel, reso
 		children: [
 			/* @__PURE__ */ jsx(Text, {
 				color: "cyan",
-				children: "keybook add"
+				children: title ?? "keybook add"
 			}),
 			/* @__PURE__ */ jsx(Box, {
 				marginTop: 1,
@@ -751,15 +839,20 @@ function AddEntryForm({ apps, existingTags, onSubmit, onComplete, onCancel, reso
 					apps,
 					appIndex,
 					focused,
-					existingTags
+					existingTags,
+					lockedApp
 				})
 			}),
-			/* @__PURE__ */ jsx(Box, {
+			/* @__PURE__ */ jsxs(Box, {
 				marginTop: 1,
-				children: /* @__PURE__ */ jsx(Text, {
-					color: hint ? "red" : "gray",
-					children: hint || "⌃N next · ⌃P prev · ⏎ review · esc cancel"
-				})
+				flexDirection: "column",
+				children: [hint ? /* @__PURE__ */ jsx(Text, {
+					color: "red",
+					children: hint
+				}) : null, /* @__PURE__ */ jsx(Text, {
+					color: "gray",
+					children: `⌃N next · ⌃P prev · ⏎ ${enterHint} · esc cancel`
+				})]
 			})
 		]
 	});
@@ -796,7 +889,20 @@ function search(entries, query) {
 }
 //#endregion
 //#region src/tui/Footer.tsx
-function Footer({ flash, errorCount, resultCount }) {
+function Footer({ flash, errorCount, resultCount, confirm }) {
+	if (confirm) return /* @__PURE__ */ jsxs(Box, {
+		marginTop: 1,
+		justifyContent: "space-between",
+		children: [/* @__PURE__ */ jsx(Text, {
+			color: "yellow",
+			wrap: "truncate-end",
+			children: confirm
+		}), /* @__PURE__ */ jsx(Text, {
+			color: "yellow",
+			bold: true,
+			children: "  y / n"
+		})]
+	});
 	return /* @__PURE__ */ jsxs(Box, {
 		marginTop: 1,
 		justifyContent: "space-between",
@@ -804,7 +910,7 @@ function Footer({ flash, errorCount, resultCount }) {
 			color: "gray",
 			wrap: "truncate-end",
 			children: [
-				"↑↓ move ⏎ copy ⌃O add ⎋ quit ⌥⌫/⌃W del ⌃U clear (",
+				"↑↓ move ⏎ copy ⌃O add ⌃E edit ⌃X del ⎋ quit ⌃U clear (",
 				resultCount,
 				")"
 			]
@@ -972,6 +1078,8 @@ function App({ entries: initial, errorCount = 0, dataDir, onCopy = copyToClipboa
 	const { stdout } = useStdout();
 	const [entries, setEntries] = useState(initial);
 	const [mode, setMode] = useState("search");
+	const [editTarget, setEditTarget] = useState(null);
+	const [pendingDelete, setPendingDelete] = useState(null);
 	const [query, setQuery] = useState("");
 	const [selected, setSelected] = useState(0);
 	const [flash, setFlash] = useState("");
@@ -984,8 +1092,24 @@ function App({ entries: initial, errorCount = 0, dataDir, onCopy = copyToClipboa
 	const listHeight = visibleListHeight(stdout?.rows);
 	const { left, right } = columnWidths(stdout?.columns);
 	useInput((input, key) => {
+		if (key.ctrl && input === "c") {
+			exit();
+			return;
+		}
+		if (pendingDelete) {
+			if ((key.return || input === "y" || input === "Y") && dataDir) {
+				const r = deleteEntry(dataDir, pendingDelete.file, pendingDelete.index, pendingDelete.action.trim());
+				if (r.ok) {
+					reload();
+					setSelected(0);
+				}
+				setFlash(r.lines[0] ?? (r.ok ? "✗ deleted" : "✗ delete failed"));
+			} else setFlash("");
+			setPendingDelete(null);
+			return;
+		}
 		if (!key.return && flash) setFlash("");
-		if (key.escape || key.ctrl && input === "c") {
+		if (key.escape) {
 			exit();
 			return;
 		}
@@ -993,6 +1117,15 @@ function App({ entries: initial, errorCount = 0, dataDir, onCopy = copyToClipboa
 			setMode("add");
 			return;
 		}
+		if (dataDir && current && key.ctrl && input === "e") {
+			setEditTarget(current);
+			setMode("edit");
+			return;
+		}
+		if (dataDir && current && key.ctrl && input === "x") {
+			setPendingDelete(current);
+			return;
+		}
 		if (key.downArrow || key.ctrl && input === "n") {
 			setSelected((s) => Math.min(s + 1, results.length - 1));
 			return;
@@ -1025,24 +1158,47 @@ function App({ entries: initial, errorCount = 0, dataDir, onCopy = copyToClipboa
 			setSelected(0);
 		}
 	}, { isActive: mode === "search" });
-	if (mode === "add" && dataDir) {
-		const existingTags = [...new Set(entries.flatMap((e) => e.tags ?? []))].sort();
-		return /* @__PURE__ */ jsx(AddEntryForm, {
-			apps: listApps(dataDir),
-			existingTags,
-			resolveTarget: (a) => resolveTargetFile(dataDir, a),
-			onSubmit: (app, entry) => addEntry(dataDir, app, entry),
-			onComplete: (result) => {
-				if (result.ok) {
-					reload();
-					setSelected(0);
-					setFlash(result.lines[0] ?? "✓ added");
-				}
-				setMode("search");
-			},
-			onCancel: () => setMode("search")
-		});
-	}
+	const existingTags = [...new Set(entries.flatMap((e) => e.tags ?? []))].sort();
+	if (mode === "add" && dataDir) return /* @__PURE__ */ jsx(AddEntryForm, {
+		apps: listApps(dataDir),
+		existingTags,
+		resolveTarget: (a) => resolveTargetFile(dataDir, a),
+		onSubmit: (app, entry) => addEntry(dataDir, app, entry),
+		onComplete: (result) => {
+			if (result.ok) {
+				reload();
+				setSelected(0);
+				setFlash(result.lines[0] ?? "✓ added");
+			}
+			setMode("search");
+		},
+		onCancel: () => setMode("search")
+	});
+	if (mode === "edit" && dataDir && editTarget) return /* @__PURE__ */ jsx(AddEntryForm, {
+		apps: listApps(dataDir),
+		existingTags,
+		lockedApp: editTarget.app,
+		initial: entryToDraft(editTarget.app, editTarget),
+		title: `Edit entry — ${editTarget.app}`,
+		resolveTarget: () => ({
+			file: editTarget.file,
+			created: false
+		}),
+		onSubmit: (_app, entry) => editEntry(dataDir, editTarget.file, editTarget.index, entry, editTarget.action),
+		onComplete: (result) => {
+			if (result.ok) {
+				reload();
+				setSelected(0);
+				setFlash(result.lines[0] ?? "✓ updated");
+			}
+			setMode("search");
+			setEditTarget(null);
+		},
+		onCancel: () => {
+			setMode("search");
+			setEditTarget(null);
+		}
+	});
 	return /* @__PURE__ */ jsxs(Box, {
 		flexDirection: "column",
 		children: [
@@ -1060,7 +1216,8 @@ function App({ entries: initial, errorCount = 0, dataDir, onCopy = copyToClipboa
 			/* @__PURE__ */ jsx(Footer, {
 				flash,
 				errorCount,
-				resultCount: results.length
+				resultCount: results.length,
+				confirm: pendingDelete ? `Delete '${pendingDelete.app}: ${pendingDelete.action}'?` : void 0
 			})
 		]
 	});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arthony/keybook",
-  "version": "0.3.2",
+  "version": "0.4.1",
   "publishConfig": {
     "access": "public"
   },

package/seed/vim.yaml

@@ -64,3 +64,115 @@ entries:
   - action: Indent / outdent the line or selection
     keys: ">>, <<"
     tags: [indent]
+  - action: Move to end of word / end of WORD
+    keys: "e, E"
+    notes: e treats punctuation as a word boundary; E spans punctuation (whitespace-separated WORD).
+    tags: [word, motion, end]
+  - action: Move forward / back by WORD (whitespace-separated)
+    keys: "W, B"
+    notes: Capital variants of w / b — jump past punctuation in one step.
+    tags: [word, motion, big]
+  - action: Find a character on the current line
+    keys: "f, F, t, T"
+    notes: >-
+      After pressing, type the target character. f / F land ON it (forward / back);
+      t / T land just before it. ; repeats the same find, , reverses direction.
+      Searches like "fa" (find 'a') are great when paired with d / c (e.g. dt, deletes to before next ',').
+    tags: [find, char, line, motion, tip]
+  - action: Search forward / back for the word under the cursor
+    keys: "*, #"
+    notes: Use n / N afterwards to step through matches. Great for tracing usages.
+    tags: [search, word, find, navigate, tip]
+  - action: Jump to top / middle / bottom of the screen
+    keys: "H, M, L"
+    notes: Cursor only — doesn't scroll the viewport. Combine with zz to recenter after.
+    tags: [screen, viewport, motion]
+  - action: Scroll half / full page down / up
+    keys: "⌃D, ⌃U, ⌃F, ⌃B"
+    notes: Half-page (⌃D / ⌃U) is usually less jarring than full-page (⌃F / ⌃B).
+    tags: [scroll, page, motion]
+  - action: Recenter / top / bottom the current line in the viewport
+    keys: "zz, zt, zb"
+    notes: zz centers the current line, zt puts it at the top of the window, zb at the bottom.
+    tags: [scroll, center, recenter, viewport]
+  - action: Jump back / forward in the cursor history
+    keys: "⌃O, ⌃I"
+    notes: >-
+      Vim records every jump >1 line. ⌃O retraces backwards through your trail, ⌃I goes forward.
+      Indispensable for diving into code and bouncing back where you were.
+    tags: [jump, history, navigate, tip, productivity]
+  - action: Jump to local declaration / global definition under cursor
+    keys: "gd, gD"
+    notes: gd searches the current function/scope for the identifier under the cursor; gD searches the whole file.
+    tags: [definition, declaration, goto, tip]
+  - action: Open a new line below / above the current
+    keys: "o, O"
+    notes: Both enter Insert mode immediately on the new line.
+    tags: [insert, new line, edit]
+  - action: Insert at start / append at end of line
+    keys: "I, A"
+    notes: I jumps to the first non-blank character and enters Insert; A appends after the last character.
+    tags: [insert, append, line, edit]
+  - action: Change / delete to end of line
+    keys: "C, D"
+    notes: C is shorthand for c$ (change to end of line); D is d$ (delete to end). Quick rewrites.
+    tags: [change, delete, line, edit]
+  - action: Replace a single character / enter Replace mode
+    keys: "r, R"
+    notes: After r, type the replacement char (one key, doesn't enter Insert). R overwrites characters as you type until ⎋.
+    tags: [replace, overwrite, edit]
+  - action: Join the next line onto the current one
+    keys: "J"
+    notes: Adds a space between them. gJ joins without inserting a space.
+    tags: [join, line, edit]
+  - action: Toggle case of character / inner word
+    keys: "~, g~iw"
+    notes: ~ flips one char's case; g~iw flips the word under the cursor. gu / gU make a motion lower / upper-case.
+    tags: [case, toggle, edit]
+  - action: Split the window horizontally / vertically
+    keys: ":split⏎, :vsplit⏎"
+    notes: Short forms :sp and :vsp. After splitting, :e <file> opens a file in the focused split.
+    tags: [split, window, layout]
+  - action: Move focus between splits
+    keys: "⌃Wh, ⌃Wj, ⌃Wk, ⌃Wl"
+    notes: ⌃W followed by an hjkl direction. ⌃W⌃W cycles forward through splits.
+    tags: [split, window, navigate]
+  - action: List and switch buffers
+    keys: ":ls⏎, :b <n>⏎, :bn, :bp"
+    notes: :ls lists all open buffers with their numbers. :bn / :bp cycle next / previous.
+    tags: [buffer, switch, list, tip]
+  - action: Close the current buffer (keep the split layout)
+    keys: ":bd⏎"
+    notes: Drops the buffer but keeps the window. Add ! to discard unsaved changes.
+    tags: [buffer, close]
+  - action: Set a mark / jump back to it
+    keys: "m, ', `"
+    notes: >-
+      m{letter} sets a mark at the cursor; '{letter} jumps to its line, `{letter} (backtick) to the exact column.
+      Lowercase marks a–z are file-local; capital A–Z are global across files.
+    tags: [mark, jump, bookmark, "ma", "'a", tip]
+  - action: Record / play back a macro
+    keys: "q...q, @, @@"
+    notes: >-
+      q{letter} starts recording into a register; q stops. @{letter} replays. @@ re-runs the last macro.
+      Workflow — record one edit on the first item, then @a (or whatever register) on each subsequent occurrence.
+    tags: [macro, record, replay, automation, tip, productivity]
+  - action: Repeat the last ex (:) command
+    keys: "@:"
+    notes: "After running any :command once, @: replays it; @@ then keeps replaying."
+    tags: [repeat, command, tip]
+  - action: Toggle relative / absolute line numbers
+    keys: ":set rnu⏎, :set nornu⏎, :set nu⏎"
+    notes: >-
+      Relative numbers (rnu) show each line's distance from the cursor — "5j" or "12dd" become trivial to count.
+      Combine `set nu` + `set rnu` for a hybrid view. Put both in your vimrc to make it permanent.
+    tags: [option, line numbers, relative, productivity, tip]
+  - action: Insert the same text on every line of a column selection
+    steps:
+      - "⌃V to enter Visual-Block mode"
+      - Use j / k to extend the block over the lines you want
+      - Press I (capital) to insert at the LEFT edge of the block
+      - Type the text you want repeated on every line
+      - "Press ⎋ — wait a moment — the text duplicates onto every selected line"
+    notes: A (capital) does the same at the RIGHT edge. Game-changer for adding comment markers, trailing commas, or any column prefix/suffix.
+    tags: [visual block, multi line, insert, comment, prefix, tip, productivity]