claude@clouddev1
028d32420d
Completes the preceding empty-rename commit: the getting-help "Hints" section — F1 for a tier-3 teaching hint on the live input, `hint` to explain the most recent error — with the real rendered block and a cast showing both (the live-input hint via the demo-mode Ctrl-G→[F1] alias, since autocast can't send F1, then `hint` on an error). the-assistive-editor points at F1; CtrlG added to the cast generator's key map.
317 lines
15 KiB
JavaScript
317 lines
15 KiB
JavaScript
/**
|
|
* Cast source definitions — the durable, human-readable source for the
|
|
* asciinema demos (ADR-website-001 §2). `pnpm casts` runs `generate.mjs`,
|
|
* which turns each definition into an autocast YAML and records it to
|
|
* `public/casts/<name>.cast`. Edit these and re-run to re-record as the app
|
|
* evolves; the `.cast` files are regenerable artifacts.
|
|
*
|
|
* Step kinds:
|
|
* { wait: ms } — pause (shown in the recording)
|
|
* { type: 'text', after: ms } — type the text + press Enter, then pause
|
|
* { type: 'text', enter: false } — type without pressing Enter
|
|
* { key: 'Tab'|'Enter'|'CtrlC'|'CtrlO'|'Esc', after } — press a single named key
|
|
* { caption: 'text', after: ms } — pop a demo caption (ADR-0047) bottom-right,
|
|
* then hold it (it clears on the next key)
|
|
*
|
|
* Every cast must end by quitting the app so the driver returns to the shell
|
|
* prompt — use `{ key: 'CtrlC' }` (Ctrl-C → quit), NOT a typed `quit`: Ctrl-C
|
|
* is invisible, so the trim ends the cast on the last content frame instead of
|
|
* a dangling `quit`.
|
|
*/
|
|
|
|
/** The shared library narrative, trimmed per cast. */
|
|
export const casts = [
|
|
{
|
|
name: 'schema-sidebar',
|
|
title: 'Bring up the schema sidebar and step through tables and relationships',
|
|
width: 90,
|
|
height: 26,
|
|
typeSpeed: '45ms',
|
|
steps: [
|
|
{ wait: 1000 },
|
|
// A small two-table schema with one relationship, so both sidebar
|
|
// panels have something to show.
|
|
{ type: 'create table authors with pk author_id(serial)', after: 650 },
|
|
{ type: 'add column to authors: name (text)', after: 650 },
|
|
{ type: 'create table books with pk book_id(serial)', after: 650 },
|
|
{ type: 'add column to books: title (text)', after: 650 },
|
|
{ type: 'add column to books: author_id (int)', after: 700 },
|
|
{
|
|
type: 'add 1:n relationship as books_author from authors.author_id to books.author_id on delete cascade',
|
|
after: 1400,
|
|
},
|
|
// The sidebar is hidden at 90 cols; Ctrl-O reveals it and focuses the
|
|
// Tables panel (the [CTRL-O] badge shows the otherwise-invisible key).
|
|
{ key: 'CtrlO', after: 2600 },
|
|
// Ctrl-O again moves focus to the Relationships panel.
|
|
{ key: 'CtrlO', after: 2800 },
|
|
// Esc leaves navigation mode — the sidebar re-hides.
|
|
{ key: 'Esc', after: 1300 },
|
|
{ key: 'CtrlC' }, // quit invisibly (Ctrl-C) — cast ends on the last content frame
|
|
],
|
|
},
|
|
{
|
|
name: 'sql-echo',
|
|
title: 'Run simple-mode commands in advanced mode and watch the SQL they map to',
|
|
width: 90,
|
|
// Taller than the other casts (26): the m:n command's echo + the junction
|
|
// structure it prints are long, and at 26 rows the head of the `Executing
|
|
// SQL:` echo — the payoff — scrolled off the top. The extra rows all go to
|
|
// the output pane (the surrounding panels are fixed-height), keeping the
|
|
// whole echo visible. Stays < 40 so the compact 1-row-input layout holds.
|
|
height: 34,
|
|
typeSpeed: '45ms',
|
|
steps: [
|
|
{ wait: 1000 },
|
|
{ type: 'mode advanced', after: 1300 },
|
|
// Each simple-mode command, run in advanced mode, echoes the equivalent
|
|
// SQL beneath it (the ADR-0038 teaching echo).
|
|
{ type: 'create table books with pk', after: 1700 },
|
|
{ type: 'add column to books: title (text)', after: 1800 },
|
|
{ type: 'create table tags with pk', after: 1600 },
|
|
{ type: 'add column to tags: label (text)', after: 1900 },
|
|
// The crescendo: one m:n command expands to a whole junction table —
|
|
// split type + Enter so the command reads before the long echo lands.
|
|
{ type: 'create m:n relationship from books to tags', enter: false, after: 1700 },
|
|
{ key: 'Enter', after: 3200 },
|
|
{ caption: 'One command builds an entire junction table.', after: 3200 },
|
|
{ key: 'CtrlC' }, // quit invisibly (Ctrl-C) — cast ends on the last content frame
|
|
],
|
|
},
|
|
{
|
|
name: 'seed',
|
|
title: 'Fill a table with realistic, ready-to-query data in one command',
|
|
width: 90,
|
|
// Two seeds: a people table (`name` → real names, `joined` → recent dates)
|
|
// and a tickets table mixing a free-text column (`subject`), an
|
|
// auto-detected `priority` (a built-in low/medium/high set, #34), and a
|
|
// `status` pinned via `set status in (...)` to show the override clause.
|
|
height: 28,
|
|
typeSpeed: '45ms',
|
|
steps: [
|
|
{ wait: 1000 },
|
|
// A people table — seed reads the column names to choose what to make.
|
|
{ type: 'create table members with pk member_id(serial)', after: 650 },
|
|
{ type: 'add column to members: name (text)', after: 650 },
|
|
{ type: 'add column to members: joined (date)', after: 800 },
|
|
// The payoff: one line, eight believable rows. Split type + Enter so the
|
|
// command reads before the table lands.
|
|
{ type: 'seed members 8', enter: false, after: 1500 },
|
|
{ key: 'Enter', after: 2800 },
|
|
{ caption: 'One line fills a table with realistic, ready-to-query data.', after: 3000 },
|
|
// A second table: a free-text column (`subject`), an auto-detected one
|
|
// (`priority`), and `status` pinned to a value set with `set`.
|
|
{ type: 'create table tickets with pk ticket_id(serial)', after: 650 },
|
|
{ type: 'add column to tickets: subject (text)', after: 650 },
|
|
{ type: 'add column to tickets: status (text)', after: 650 },
|
|
{ type: 'add column to tickets: priority (text)', after: 800 },
|
|
// `subject` and `priority` are generated; `status` is pinned to a set.
|
|
{ type: "seed tickets 8 set status in ('open', 'pending', 'closed')", enter: false, after: 1600 },
|
|
{ key: 'Enter', after: 2800 },
|
|
{ caption: 'Generate most columns — and pin one to your own values with set.', after: 3000 },
|
|
{ key: 'CtrlC' }, // quit invisibly (Ctrl-C) — cast ends on the last content frame
|
|
],
|
|
},
|
|
{
|
|
name: 'projects',
|
|
title: 'Save a project, start fresh, then load it back',
|
|
width: 90,
|
|
height: 26,
|
|
typeSpeed: '45ms',
|
|
dataDir: true, // isolated data root → picker lists only this cast's projects
|
|
steps: [
|
|
{ wait: 1000 },
|
|
{ type: 'create table books with pk', after: 600 },
|
|
{ type: 'add column to books: title (text)', after: 700 },
|
|
{ type: "insert into books (title) values ('A Wizard of Earthsea')", after: 800 },
|
|
{ type: 'show tables', after: 2000 }, // the project has a "books" table
|
|
// save-as: type the name, PAUSE so the viewer reads it, then confirm.
|
|
{ type: 'save as', after: 1100 }, // opens the name prompt
|
|
{ type: 'library', enter: false, after: 1500 }, // type the name (no Enter yet)
|
|
{ key: 'Enter', after: 1600 }, // confirm → saved as "library"
|
|
// new: type it, pause, then run — so "new" registers before it executes.
|
|
{ type: 'new', enter: false, after: 1100 },
|
|
{ key: 'Enter', after: 1500 },
|
|
{ type: 'show tables', after: 2200 }, // fresh project — no tables
|
|
{ type: 'load', after: 1300 }, // opens the project picker
|
|
{ type: 'j', enter: false, after: 1100 }, // move the selection to "library"
|
|
{ key: 'Enter', after: 1800 }, // load it
|
|
{ type: 'show tables', after: 2200 }, // "books" is back
|
|
{ key: 'CtrlC' }, // quit invisibly (Ctrl-C) — cast ends on the last content frame
|
|
],
|
|
},
|
|
{
|
|
name: 'modes',
|
|
title: 'Simple mode, then advanced — with the SQL the playground runs for you',
|
|
width: 90,
|
|
height: 26,
|
|
typeSpeed: '45ms',
|
|
steps: [
|
|
{ wait: 1000 },
|
|
{ type: 'create table books with pk', after: 700 },
|
|
{ type: 'add column to books: title (text)', after: 800 },
|
|
{ type: "insert into books (title) values ('A Wizard of Earthsea')", after: 650 },
|
|
{ type: "insert into books (title) values ('Invisible Cities')", after: 1100 },
|
|
{ type: 'show data books', after: 1600 }, // simple mode — no SQL echo
|
|
// Split the mode switch (type → beat → submit) so the short, pivotal
|
|
// command reads before the screen changes.
|
|
{ type: 'mode advanced', enter: false, after: 1100 },
|
|
{ key: 'Enter', after: 1300 },
|
|
{ type: 'show data books', after: 2400 }, // advanced — shows "Executing SQL: …"
|
|
{ key: 'CtrlC' }, // quit invisibly (Ctrl-C) — cast ends on the last content frame
|
|
],
|
|
},
|
|
{
|
|
name: 'undo-redo',
|
|
title: 'Undo a change — then redo it — each with a confirmation',
|
|
width: 90,
|
|
height: 26,
|
|
typeSpeed: '45ms',
|
|
steps: [
|
|
{ wait: 1000 },
|
|
{ type: 'create table books with pk', after: 700 },
|
|
{ type: 'add column to books: title (text)', after: 800 },
|
|
{ type: "insert into books (title) values ('A Wizard of Earthsea')", after: 650 },
|
|
{ type: "insert into books (title) values ('Invisible Cities')", after: 1100 },
|
|
{ type: 'show data books', after: 1500 }, // two rows
|
|
// Split the short command from its submit so `undo` reads before the
|
|
// confirmation modal pops over it.
|
|
{ type: 'undo', enter: false, after: 1000 },
|
|
{ key: 'Enter', after: 1300 }, // submit → opens the confirmation modal
|
|
{ type: 'y', enter: false, after: 1600 }, // Y confirms
|
|
{ type: 'show data books', after: 1500 }, // one row
|
|
{ type: 'redo', enter: false, after: 1000 },
|
|
{ key: 'Enter', after: 1300 },
|
|
{ type: 'y', enter: false, after: 1600 },
|
|
{ type: 'show data books', after: 1700 }, // two rows again
|
|
{ key: 'CtrlC' }, // quit invisibly (Ctrl-C) — cast ends on the last content frame
|
|
],
|
|
},
|
|
{
|
|
name: 'joins',
|
|
title: 'Switch to advanced mode and join across tables',
|
|
width: 90,
|
|
height: 26,
|
|
typeSpeed: '42ms',
|
|
steps: [
|
|
{ wait: 900 },
|
|
// minimal two-table schema + a few rows to join
|
|
{ type: 'create table authors with pk author_id(serial)', after: 650 },
|
|
{ type: 'add column to authors: name (text)', after: 650 },
|
|
{ type: 'create table books with pk book_id(serial)', after: 650 },
|
|
{ type: 'add column to books: title (text)', after: 650 },
|
|
{ type: 'add column to books: author_id (int)', after: 800 },
|
|
{ type: "insert into authors (name) values ('Ursula K. Le Guin')", after: 600 },
|
|
{ type: "insert into authors (name) values ('Italo Calvino')", after: 700 },
|
|
{ type: "insert into books (title, author_id) values ('A Wizard of Earthsea', 1)", after: 600 },
|
|
{ type: "insert into books (title, author_id) values ('The Left Hand of Darkness', 1)", after: 600 },
|
|
{ type: "insert into books (title, author_id) values ('Invisible Cities', 2)", after: 900 },
|
|
// Surface the two source tables before joining them — at 90 cols the
|
|
// schema sidebar is hidden, so this is how the viewer sees what's there.
|
|
{ type: 'show data authors', after: 1600 },
|
|
{ type: 'show data books', after: 1900 },
|
|
// switch to SQL and join (split the mode switch for a readable beat)
|
|
{ type: 'mode advanced', enter: false, after: 1100 },
|
|
{ key: 'Enter', after: 1300 },
|
|
{
|
|
type: 'select authors.name, books.title from books join authors on books.author_id = authors.author_id order by authors.name',
|
|
after: 2600,
|
|
},
|
|
{ caption: 'Each book paired with its author, joined across the two tables.', after: 3200 },
|
|
{ key: 'CtrlC' }, // quit invisibly (Ctrl-C) — cast ends on the last content frame
|
|
],
|
|
},
|
|
{
|
|
name: 'relationship-diagram',
|
|
title: 'Declare a relationship and see it drawn',
|
|
width: 90,
|
|
height: 26,
|
|
typeSpeed: '45ms',
|
|
steps: [
|
|
{ wait: 900 },
|
|
{ type: 'create table authors with pk author_id(serial)', after: 800 },
|
|
{ type: 'add column to authors: name (text)', after: 900 },
|
|
{ type: 'create table books with pk book_id(serial)', after: 800 },
|
|
{ type: 'add column to books: title (text)', after: 700 },
|
|
{ type: 'add column to books: author_id (int)', after: 1000 },
|
|
{
|
|
type: 'add 1:n relationship as books_author from authors.author_id to books.author_id on delete cascade',
|
|
after: 1400,
|
|
},
|
|
// the money shot: the two-table connector diagram
|
|
{ type: 'show relationship books_author', after: 2600 },
|
|
{ caption: 'Many books, each pointing at one author.', after: 3200 },
|
|
{ key: 'CtrlC' }, // quit invisibly (Ctrl-C) — cast ends on the last content frame
|
|
],
|
|
},
|
|
{
|
|
name: 'assistive-editor',
|
|
title: 'The input field helps as you type — completion and a live validity indicator',
|
|
width: 90,
|
|
height: 26,
|
|
typeSpeed: '55ms',
|
|
steps: [
|
|
{ wait: 1100 },
|
|
{ type: 'create table books with pk', after: 850 },
|
|
{ type: 'add column to books: title (text)', after: 1100 },
|
|
// Completion: type a partial table name, press Tab to complete it.
|
|
{ type: 'show data bo', enter: false, after: 1100 },
|
|
{ key: 'Tab', after: 1400 },
|
|
{ key: 'Enter', after: 1600 },
|
|
// Validity indicator: a misspelled table flags [ERR] before you submit.
|
|
{ type: 'show data boook', enter: false, after: 1900 },
|
|
{ key: 'Enter', after: 1700 },
|
|
// The corrected command runs cleanly.
|
|
{ type: 'show data books', after: 1600 },
|
|
{ key: 'CtrlC' }, // quit invisibly (Ctrl-C) — cast ends on the last content frame
|
|
],
|
|
},
|
|
{
|
|
name: 'hint',
|
|
title: 'Ask for a hint — on the command you are typing, or on the last error',
|
|
width: 90,
|
|
// Taller: the tier-3 hint blocks (What / Example / Concept) plus the command
|
|
// echoes need the room. The live-input hint is opened with Ctrl-G, which in
|
|
// --demo mode aliases F1 and badges AS [F1] (ADR-0047 Amendment 1) — autocast
|
|
// can't send F1 (an escape sequence), so this control byte stands in for it.
|
|
height: 30,
|
|
typeSpeed: '45ms',
|
|
steps: [
|
|
{ wait: 1000 },
|
|
{ type: 'create table customers with pk id(serial)', after: 650 },
|
|
{ type: 'add column to customers: email (text)', after: 850 },
|
|
// Live-input hint: type a command but DON'T submit, then Ctrl-G (badged
|
|
// [F1]) opens a teaching hint for the command being built.
|
|
{ type: "insert into customers (email) values ('ada@example.io')", enter: false, after: 1500 },
|
|
{ key: 'CtrlG', after: 3400 }, // [F1] badge + the insert hint block — hold to read
|
|
{ key: 'Enter', after: 2000 }, // the buffer is intact → submit the insert
|
|
// Error-recovery hint: a command that fails, then `hint` explains it.
|
|
{ type: 'show data orders', after: 2200 }, // no such table → friendly error
|
|
{ type: 'hint', enter: false, after: 1200 },
|
|
{ key: 'Enter', after: 3400 }, // the error hint block — hold to read
|
|
{ caption: 'A hint for what you are typing, or for the last error.', after: 3200 },
|
|
{ key: 'CtrlC' }, // quit invisibly (Ctrl-C) — cast ends on the last content frame
|
|
],
|
|
},
|
|
{
|
|
name: 'quickstart',
|
|
title: 'RDBMS Playground — first table to first query',
|
|
width: 90,
|
|
height: 26,
|
|
typeSpeed: '45ms',
|
|
holdEnd: 2.5, // landing cast loops — pause on the final frame before restart
|
|
steps: [
|
|
{ wait: 1100 },
|
|
{ type: 'create table authors with pk', after: 1000 },
|
|
{ type: 'add column to authors: name (text)', after: 850 },
|
|
{ type: 'add column to authors: birth_year (int)', after: 900 },
|
|
{
|
|
type: "insert into authors (name, birth_year) values ('Ursula K. Le Guin', 1929)",
|
|
after: 1300,
|
|
},
|
|
{ type: 'show data authors', after: 1800 },
|
|
{ key: 'CtrlC' }, // quit invisibly (Ctrl-C) — cast ends on the last content frame
|
|
],
|
|
},
|
|
];
|