pi-ebb 1.0.0 → 1.1.1

package/README.md

@@ -1,10 +1,15 @@
 # pi-ebb
 
-Spaced repetition in the background of [pi](https://pi.dev). It teaches you words, phrases or any other facts while you work.
+**Learn while your agent thinks.** Spaced repetition in the background of [pi](https://pi.dev): one card above the editor while pi works, graded with one shortcut. A language, or any other facts you want to keep.
 
-```text
-el corazón  │  alt+r Forgot  alt+g Got it  alt+s Skip
-```
+![ebb in pi: a Spanish card above the editor while pi works](https://raw.githubusercontent.com/r13v/ebb/main/assets/pi.png)
+
+- **No new habit.** It uses the seconds you already wait for the agent.
+- **Never in your way.** Grade with `alt+1`, `alt+2` or a click; the editor keeps every key you type. No pop-up, ever.
+- **FSRS-6**, the scheduler of Anki: each card comes back just before you would forget it.
+- **Decks in one command**, checked by back-translation, or a ready deck of about 2000 Spanish words.
+
+Site and decks: <https://r13v.github.io/ebb/>
 
 ## Install
 
@@ -20,10 +25,13 @@ pi install npm:pi-ebb
 
 The card shows above the editor. The shortcuts never take a key the editor types:
 
-- `alt+r`: Forgot, and Next after the answer.
-- `alt+g`: Got it.
-- `alt+s`: Skip.
+- `alt+1` (Option+1 on a Mac): Forgot, and Next after the answer.
+- `alt+2`: Got it.
+- `alt+3`: Skip.
 - `alt+h`: hide or show the card.
+- Or click a button of the band (pi's fullscreen mode, the default).
+
+On a Mac, Option must work as Alt: in Ghostty or agterm set `macos-option-as-alt = true`, in iTerm2 set the Option key to Esc+. Otherwise Option+1 types `¡`; click the band instead.
 
 The scheduler is FSRS-6. The data is in `$XDG_DATA_HOME/ebb/` (by default `~/.local/share/ebb/`), shared with the [Claude Code mod](https://github.com/r13v/ebb).
 

package/dist/index.js

@@ -1,5 +1,5 @@
 import { homedir } from "node:os";
-import { matchesKey, truncateToWidth } from "@earendil-works/pi-tui";
+import { MouseRegion, matchesKey, truncateToWidth, visibleWidth } from "@earendil-works/pi-tui";
 import { mkdir, readFile, rename, rm, stat, writeFile } from "node:fs/promises";
 import { dirname } from "node:path";
 // core/decks.ts
@@ -707,8 +707,8 @@ var createSession = () => {
 	const endTurn = async (host) => {
 		if (!band.isRevealed) await showNextCard(host, void 0, true);
 	};
-	/** What the band draws now; `shown` is the band as the host keeps it. A reader on every render: it never throws. */
-	const bandView = async (host, shown = band) => {
+	/** What the band draws now. A reader on every render: it never throws. */
+	const bandView = async (host) => {
 		let data;
 		try {
 			data = await load(host);
@@ -719,13 +719,13 @@ var createSession = () => {
 			};
 		}
 		if (!Object.keys(data.decks).length) return { kind: "no-deck" };
-		const card = shown.cardId ? data.cards[shown.cardId] : void 0;
+		const card = band.cardId ? data.cards[band.cardId] : void 0;
 		const f = card && face(data, card);
 		if ((data.meta.pausedUntil ?? 0) > Date.now() || !f) return { kind: "none" };
 		return {
 			kind: "card",
 			face: f,
-			isRevealed: shown.isRevealed
+			isRevealed: band.isRevealed
 		};
 	};
 	/**
@@ -981,32 +981,72 @@ var fileHost = (home, dir) => ({
 // pi/index.ts
 var WIDGET = "ebb";
 var KEYS = {
-	forgot: "alt+r",
-	got: "alt+g",
-	skip: "alt+s",
+	forgot: "alt+1",
+	got: "alt+2",
+	skip: "alt+3",
 	toggle: "alt+h"
 };
 var files = fileHost(homedir(), dataDir(homedir(), process.env.XDG_DATA_HOME));
 var SETTINGS = `${files.dir}/pi.json`;
 var textOf = (content) => content.filter((c) => c.type === "text").map((c) => c.text).join("");
-/** The lines of the band; none while it is hidden, paused or without a card. */
-var bandLines = (v, theme) => {
-	if (v.kind === "error") return [theme.fg("error", `ebb: cannot read the data: ${v.error}`)];
-	if (v.kind === "no-deck") return [theme.fg("dim", "ebb: /ebb add <topic> or /ebb install <file or URL> to get cards")];
+/** The pieces of the band; none while it is paused or without a card. */
+var bandParts = (v, theme) => {
+	if (v.kind === "error") return [{ text: theme.fg("error", `ebb: cannot read the data: ${v.error}`) }];
+	if (v.kind === "no-deck") return [{ text: theme.fg("dim", "ebb: /ebb add <topic> or /ebb install <file or URL> to get cards") }];
 	if (v.kind === "none") return void 0;
 	const f = v.face;
-	const bar = theme.fg("dim", "│");
-	const key = (keys, label) => `${theme.fg("accent", keys)} ${label}`;
+	const bar = { text: `  ${theme.fg("dim", "│")}  ` };
+	const button = (key, label, action) => ({
+		text: `${theme.fg("accent", key)} ${label}`,
+		action
+	});
+	const gap = { text: "  " };
 	if (v.isRevealed) {
 		const hint = f.hint ? theme.fg("dim", ` (${f.hint})`) : "";
-		return [`${theme.bold(f.ask)} — ${f.answer}${hint}  ${bar}  ${key(KEYS.forgot, "Next")}`];
+		return [
+			{ text: `${theme.bold(f.ask)} — ${f.answer}${hint}` },
+			bar,
+			button(KEYS.forgot, "Next", "next")
+		];
 	}
-	const keys = [
-		key(KEYS.forgot, "Forgot"),
-		key(KEYS.got, "Got it"),
-		key(KEYS.skip, "Skip")
-	].join("  ");
-	return [`${theme.bold(f.ask)}  ${bar}  ${keys}`];
+	return [
+		{ text: theme.bold(f.ask) },
+		bar,
+		button(KEYS.forgot, "Forgot", "forgot"),
+		gap,
+		button(KEYS.got, "Got it", "got"),
+		gap,
+		button(KEYS.skip, "Skip", "skip")
+	];
+};
+/**
+* The band as one line, indented as pi indents a widget, with the columns of its buttons. pi passes a
+* click only in its fullscreen mode, so every button also has a key.
+*/
+var bandWidget = (parts, press) => (_tui, _theme) => {
+	let buttons = [];
+	return new MouseRegion({
+		render: (width) => {
+			let column = 1;
+			buttons = [];
+			for (const part of parts) {
+				const partWidth = visibleWidth(part.text);
+				if (part.action) buttons.push({
+					from: column,
+					to: column + partWidth,
+					action: part.action
+				});
+				column += partWidth;
+			}
+			return [truncateToWidth(` ${parts.map((p) => p.text).join("")}`, width)];
+		},
+		invalidate: () => void 0
+	}, (event) => {
+		const hit = buttons.find((b) => event.x >= b.from && event.x < b.to);
+		if (event.type !== "click" || event.button !== "left" || !hit) return void 0;
+		press(hit.action);
+		return { handled: true };
+	});
 };
 function ebb(pi) {
 	const session = createSession();
@@ -1015,8 +1055,8 @@ function ebb(pi) {
 	const draw = async () => {
 		if (!ctx?.hasUI) return;
 		const ui = ctx.ui;
-		const lines = isHidden ? void 0 : bandLines(await session.bandView(host), ui.theme);
-		ui.setWidget(WIDGET, lines);
+		const parts = isHidden ? void 0 : bandParts(await session.bandView(host), ui.theme);
+		ui.setWidget(WIDGET, parts && bandWidget(parts, (action) => void press(action)));
 	};
 	const host = {
 		...files,
@@ -1052,11 +1092,25 @@ function ebb(pi) {
 			notify(`ebb: ${String(error)}`, "error");
 		}
 	};
-	/** A band shortcut acts only on a card the band shows. */
-	const onCard = (work) => act(async () => {
+	/** What a button of the band does, from its key or a click; only on a card the band shows. */
+	const run = async (action) => {
 		const v = await session.bandView(host);
-		if (!isHidden && v.kind === "card") await work(v.isRevealed);
-	});
+		if (isHidden || v.kind !== "card") return;
+		if (v.isRevealed) {
+			if (action === "forgot" || action === "next") await session.next(host);
+			return;
+		}
+		if (action === "forgot") await session.gradeCard(host, 1);
+		if (action === "got") await session.gradeCard(host, 3);
+		if (action === "skip") await session.skip(host);
+	};
+	const press = async (action) => {
+		try {
+			await run(action);
+		} catch (error) {
+			notify(`ebb: ${String(error)}`, "error");
+		}
+	};
 	const showNextCard = async () => {
 		const error = await session.showNextCard(host);
 		if (error) notify(`ebb: ${error}`, "error");
@@ -1149,15 +1203,15 @@ function ebb(pi) {
 	});
 	pi.registerShortcut(KEYS.forgot, {
 		description: "ebb: Forgot, or Next after the answer",
-		handler: onCard((isRevealed) => isRevealed ? session.next(host) : session.gradeCard(host, 1))
+		handler: act(() => run("forgot"))
 	});
 	pi.registerShortcut(KEYS.got, {
 		description: "ebb: Got it",
-		handler: onCard(async (isRevealed) => !isRevealed && session.gradeCard(host, 3))
+		handler: act(() => run("got"))
 	});
 	pi.registerShortcut(KEYS.skip, {
 		description: "ebb: skip the card",
-		handler: onCard(async (isRevealed) => !isRevealed && session.skip(host))
+		handler: act(() => run("skip"))
 	});
 	pi.registerShortcut(KEYS.toggle, {
 		description: "ebb: hide or show the card above the editor",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pi-ebb",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "Spaced repetition in the background of pi: a card above the editor, graded with a shortcut",
   "license": "MIT",
   "type": "module",
@@ -12,7 +12,7 @@
   "bugs": {
     "url": "https://github.com/r13v/ebb/issues"
   },
-  "homepage": "https://github.com/r13v/ebb/tree/main/pi#readme",
+  "homepage": "https://r13v.github.io/ebb/",
   "publishConfig": {
     "access": "public"
   },