@profullstack/readm3 0.1.1 → 0.3.0

package/README.md

@@ -1,7 +1,12 @@
 # readm3
 
-A terminal markdown reader. File browser on the left, the rendered document on
-the right, and nothing else in the way.
+A terminal markdown reader and editor. File browser on the left, the rendered
+document on the right, and nothing else in the way. Press `e` to edit the file
+you are looking at, `esc` to see it rendered again.
+
+CommonMark and GitHub Flavored Markdown, plus the extras each dialect added on
+top: GitHub alerts, footnotes and `:emoji:`, and Reddit spoilers, superscript
+and `r/` `u/` links.
 
 Built on [HQTUI](https://github.com/profullstack/hqtui) — truecolor, mouse, and
 a terminal that gets restored no matter how the process dies.
@@ -47,6 +52,23 @@ readm3 CHANGELOG.md     # open a file, browse its directory
 readm3 --theme nord     # pick a palette
 ```
 
+### Printing
+
+`--print` renders straight to stdout and exits, so it works in a pipe and as a
+`cat` for markdown:
+
+```bash
+readm3 --print CHANGELOG.md          # rendered, colored, to the terminal
+readm3 --print README.md | less -R   # into a pager
+curl -s https://example.com/x.md | readm3 --print
+readm3 --print notes.md | grep TODO  # no escapes when stdout is a pipe
+```
+
+Color follows the usual rules: on when stdout is a terminal, off when it is not,
+and `NO_COLOR` / `FORCE_COLOR` are honored. `--color always|never|auto` overrides
+that either way. With `--print`, `--width` sets the render width rather than the
+sidebar.
+
 The browser only shows markdown. Directories with nothing beneath them are
 pruned, `node_modules` and friends are never walked, and README sorts first.
 
@@ -59,29 +81,87 @@ pruned, `node_modules` and friends are never walked, and README sorts first.
 | `enter` | open the file | `esc` | clear the filter |
 | `space` `b` | page down / up | `r` | rescan and reload |
 | `g` `G` | top / bottom | `[` `]` | sidebar width |
-| `?` | help | `q` `ctrl+c` | quit |
+| `e` `i` | edit this file | `s` | reveal spoilers |
+| `ctrl+s` | save | `?` | help |
+| | | `q` `ctrl+c` | quit |
 
 The mouse works too: the wheel scrolls whichever pane it is over, and a click
 opens a file.
 
+### Editing
+
+`e` puts the caret in the file. `esc` takes it out, and the preview re-renders
+what you just typed — there is no separate preview pane to keep in step,
+because both modes read the same buffer.
+
+| | | | |
+|---|---|---|---|
+| `esc` | back to the preview | `ctrl+s` | save |
+| `ctrl+z` `ctrl+y` | undo / redo | `ctrl+g` | keys |
+| `ctrl+a` `ctrl+e` | line start / end | `ctrl+k` | kill to end of line |
+| `ctrl+←` `ctrl+→` | move by word | `ctrl+u` | kill to start of line |
+| `ctrl+home` `ctrl+end` | top / bottom | `tab` | indent two spaces |
+
+`enter` continues the list you are in — the same bullet, the next number, an
+unchecked box for a task — and ends it when you press it on an empty item.
+Quitting or switching files with unsaved changes asks first. `--read-only`
+turns editing off entirely, for use as a pager.
+
+There is no selection, and so no cut and paste: this is a place to fix a typo
+and add a paragraph, not a replacement for your editor. `$EDITOR` is still
+`$EDITOR`.
+
 ## What it renders
 
-Headings, **bold**, *italic*, `inline code`, links, fenced and indented code
-blocks with a language label, ordered and unordered lists, nested lists, task
-lists, blockquotes, tables with per-column alignment, horizontal rules, images
-as labelled placeholders, and YAML front matter — shown rather than hidden,
-because it is usually what you opened the file for.
+Parsing is [marked](https://github.com/markedjs/marked) — CommonMark and GFM,
+zero dependencies of its own — so readm3 has two dependencies in total.
+
+Headings, **bold**, *italic*, `inline code`, links, reference links, bare URLs,
+fenced and indented code blocks with a language label, ordered and unordered
+lists, nested lists, task lists, blockquotes, tables with per-column alignment,
+strikethrough, hard line breaks, horizontal rules, images as labelled
+placeholders, and YAML front matter — shown rather than hidden, because it is
+usually what you opened the file for.
 
 The HTML that real READMEs are full of is folded back into markdown rather than
-printed as tags, and inline code is held out of that, so `Array<string>`
-survives.
+printed as tags, and code is held out of that, so `Array<string>` survives.
+
+### Flavors
+
+`--flavor` picks which dialect's extras are honored. The default is `github`.
+
+| flavor | adds |
+|---|---|
+| `commonmark` | nothing beyond CommonMark |
+| `github` | GFM, alerts (`> [!WARNING]`), footnotes (`[^1]`), `:emoji:` |
+| `reddit` | GFM, spoilers (`>!hidden!<`), superscript (`^(text)`), `r/` and `u/` links |
+| `all` | both dialects at once |
+
+It matters which one you pick. `2^32` is a number in a README and a superscript
+on Reddit, and `>!spoiler!<` is a blockquote everywhere except Reddit — so the
+flavor decides, rather than every document getting every rule.
+
+Alerts get a gutter colored by severity. Footnotes are numbered in order of
+first reference and collected under a rule at the foot of the document.
+Superscript uses real Unicode glyphs when every character has one (`mc^2`
+becomes mc²) and keeps its caret when they do not, because there is no
+superscript `q`. Spoilers are blocked out with `█` rather than colored out, so
+they stay hidden in a pipe and with `--color never`; `s` reveals them in the
+reader, `--spoilers` in `--print`.
 
 ## Options
 
 ```
+-p, --print          render to stdout and exit; reads stdin when given no path
+                     or "-"
+    --color <when>   always, never, or auto (default)
 -t, --theme <name>   dark, dracula, nord, tokyo-night, gruvbox, matrix,
                      monochrome, high-contrast, light
--w, --width <n>      sidebar width in columns (default: 28% of the terminal)
+-w, --width <n>      sidebar width in columns, or the render width with --print
+                     (default: 28% of the terminal, its full width printing)
+-f, --flavor <name>  commonmark, github (default), reddit, or all
+    --spoilers       reveal spoiler text instead of blocking it out
+-R, --read-only      refuse to edit, for use as a pager
 -a, --all            include dot-directories and dotfiles
 -M, --no-mouse       disable mouse tracking
 -v, --version
@@ -90,22 +170,40 @@ survives.
 
 ## As a library
 
-The renderer and the file tree are pure and need no terminal, so they can be
-reused on their own:
+The renderer, the file tree and the edit buffer are pure and need no terminal,
+so they can be reused on their own:
 
 ```ts
-import { renderMarkdown, toText, scan, files } from "@profullstack/readm3";
+import { renderMarkdown, toText, renderAnsi, scan, files } from "@profullstack/readm3";
 
 const lines = renderMarkdown("# Hello\n\nSome **text**.", 60);
 console.log(toText(lines));
 // [ 'Hello', '━━━…', '', 'Some text.' ]
 
+// A flavor, and spoilers revealed.
+renderMarkdown(post, 60, { flavor: "reddit", spoilers: true });
+
 for (const file of files(scan("./docs"))) console.log(file.path);
 ```
 
+The edit buffer is a plain object with functions over it, so the editing rules
+can be tested without a screen:
+
+```ts
+import { createEditor, insert, newline, undo, text } from "@profullstack/readm3";
+
+const ed = createEditor("- first");
+ed.col = 7;
+newline(ed);          // continues the list
+insert(ed, "second");
+console.log(text(ed)); // "- first\n- second"
+undo(ed);
+```
+
 `renderMarkdown` returns lines of spans carrying a semantic `role` — `h1`,
 `code`, `link`, `quote` and so on — rather than colors, so the same document can
-be re-themed without re-parsing.
+be re-themed without re-parsing. `renderAnsi(source, width, theme, depth)` is
+what `--print` uses to turn those spans into an escaped string.
 
 ## Runtimes
 
@@ -117,11 +215,24 @@ Windows Terminal.
 ```bash
 bun install
 bun src/cli.ts .     # run it against its own repo
-bun test test/       # 48 tests, no TTY needed
+bun test test/       # 68 tests, no TTY needed
+npm test             # the same tests on node
 bun run typecheck
 bun run build
 ```
 
+## The website
+
+[readm3.com](https://readm3.com) is built from this repository by `site/build.ts`,
+which renders every document on the page through `renderMarkdown` and takes every
+color from a real HQTUI theme. There is no second implementation to keep in sync:
+change the parser and the site changes with it.
+
+```bash
+bun run site:build   # writes site/dist
+bun run site:start   # serves it on $PORT, default 3000
+```
+
 ## License
 
 MIT.

package/dist/cli.d.ts

@@ -1,8 +1,16 @@
+import { type ColorMode } from "./print.ts";
 import { type ViewerOptions } from "./viewer.ts";
-export declare const VERSION = "0.1.1";
+export declare const VERSION = "0.3.0";
+/** The help text, exported so a test can hold it to the flags it documents. */
+export declare const USAGE: string;
 export interface ParsedArgs extends ViewerOptions {
     help: boolean;
     version: boolean;
+    /** Render to stdout instead of opening the reader. */
+    print: boolean;
+    color: ColorMode;
+    /** Reveal spoiler text rather than blocking it out. */
+    spoilers: boolean;
 }
 export declare function parseArgs(argv: string[]): ParsedArgs;
 export declare function main(argv?: string[]): Promise<void>;

package/dist/cli.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAOA,OAAO,EAAO,KAAK,aAAa,EAAE,MAAM,aAAa,CAAC;AAEtD,eAAO,MAAM,OAAO,UAAU,CAAC;AA2B/B,MAAM,WAAW,UAAW,SAAQ,aAAa;IAC/C,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;CAClB;AAID,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,UAAU,CAuEpD;AAED,wBAAsB,IAAI,CAAC,IAAI,GAAE,MAAM,EAA0B,GAAG,OAAO,CAAC,IAAI,CAAC,CA4BhF"}
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAQA,OAAO,EAA8B,KAAK,SAAS,EAAE,MAAM,YAAY,CAAC;AACxE,OAAO,EAAO,KAAK,aAAa,EAAE,MAAM,aAAa,CAAC;AAEtD,eAAO,MAAM,OAAO,UAAU,CAAC;AAE/B,+EAA+E;AAC/E,eAAO,MAAM,KAAK,QA0CjB,CAAC;AAEF,MAAM,WAAW,UAAW,SAAQ,aAAa;IAC/C,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,OAAO,CAAC;IACjB,sDAAsD;IACtD,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,SAAS,CAAC;IACjB,uDAAuD;IACvD,QAAQ,EAAE,OAAO,CAAC;CACnB;AAID,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,UAAU,CA6GpD;AAED,wBAAsB,IAAI,CAAC,IAAI,GAAE,MAAM,EAA0B,GAAG,OAAO,CAAC,IAAI,CAAC,CAwChF"}

package/dist/cli.js

@@ -5,9 +5,12 @@ import { statSync } from "node:fs";
 import { dirname, resolve } from "node:path";
 import { pathToFileURL } from "node:url";
 import { themeList } from "@profullstack/hqtui";
+import { FLAVORS, isFlavor } from "./flavors.js";
+import { printDocument, COLOR_MODES } from "./print.js";
 import { run } from "./viewer.js";
-export const VERSION = "0.1.1";
-const USAGE = `readm3 — a terminal markdown reader
+export const VERSION = "0.3.0";
+/** The help text, exported so a test can hold it to the flags it documents. */
+export const USAGE = `readm3 — a terminal markdown reader and editor
 
 Usage
   readm3 [path] [options]
@@ -16,8 +19,19 @@ Usage
                   current directory.
 
 Options
+  -p, --print          Render to stdout and exit, instead of opening the reader.
+                       Reads stdin when no path is given, or the path is "-"
+      --color <when>   always, never, or auto (the default): color when stdout
+                       is a terminal. NO_COLOR and FORCE_COLOR are honored
   -t, --theme <name>   Color theme. One of: ${themeList.map((t) => t.name).join(", ")}
-  -w, --width <n>      Sidebar width in columns. Default: 28% of the terminal
+  -w, --width <n>      Sidebar width in columns, or the render width with
+                       --print. Default: 28% of the terminal, and its full
+                       width when printing
+  -f, --flavor <name>  Markdown dialect. One of: ${FLAVORS.join(", ")}.
+                       Default: github (GFM, alerts, footnotes, :emoji:).
+                       reddit adds spoilers, superscript and r/ u/ links
+      --spoilers       Reveal spoiler text instead of blocking it out
+  -R, --read-only      Refuse to edit, for use as a pager
   -a, --all            Include dot-directories and dotfiles
   -M, --no-mouse       Disable mouse tracking
   -v, --version        Print the version
@@ -28,8 +42,16 @@ Keys
   right/left l h expand or collapse    /        filter files
   enter          open the file         r        rescan and reload
   space / b      page down / up        [ ]      sidebar width
-  g / G          top / bottom          ?        help
-                                       q        quit
+  g / G          top / bottom          s        reveal spoilers
+  e / i          edit this file        ?        help
+  ctrl+s         save                  q        quit
+
+Editing
+  esc            back to the preview, which re-renders as you left it
+  ctrl+z ctrl+y  undo / redo           ctrl+k   kill to end of line
+  ctrl+a ctrl+e  line start / end      ctrl+u   kill to start of line
+  ctrl+arrow     move by word          enter    split, continuing a list
+  ctrl+g         keys for editing      tab      indent two spaces
 `;
 class UsageError extends Error {
 }
@@ -38,8 +60,12 @@ export function parseArgs(argv) {
         root: process.cwd(),
         help: false,
         version: false,
+        print: false,
+        color: "auto",
+        spoilers: false,
         mouse: true,
         all: false,
+        readOnly: false,
     };
     let target;
     for (let i = 0; i < argv.length; i++) {
@@ -71,6 +97,34 @@ export function parseArgs(argv) {
                 parsed.sidebar = value;
                 break;
             }
+            case "-p":
+            case "--print":
+                parsed.print = true;
+                break;
+            case "--color": {
+                const value = next();
+                if (!COLOR_MODES.includes(value)) {
+                    throw new UsageError(`--color must be one of: ${COLOR_MODES.join(", ")}`);
+                }
+                parsed.color = value;
+                break;
+            }
+            case "-f":
+            case "--flavor": {
+                const value = next();
+                if (!isFlavor(value)) {
+                    throw new UsageError(`--flavor must be one of: ${FLAVORS.join(", ")}`);
+                }
+                parsed.flavor = value;
+                break;
+            }
+            case "--spoilers":
+                parsed.spoilers = true;
+                break;
+            case "-R":
+            case "--read-only":
+                parsed.readOnly = true;
+                break;
             case "-a":
             case "--all":
                 parsed.all = true;
@@ -88,6 +142,11 @@ export function parseArgs(argv) {
                 break;
         }
     }
+    if (target === "-") {
+        if (!parsed.print)
+            throw new UsageError('"-" only makes sense with --print');
+        return parsed;
+    }
     if (target !== undefined) {
         const path = resolve(target);
         let isDir;
@@ -98,6 +157,8 @@ export function parseArgs(argv) {
             throw new UsageError(`No such file or directory: ${target}`);
         }
         if (isDir) {
+            if (parsed.print)
+                throw new UsageError("--print needs a file, not a directory");
             parsed.root = path;
         }
         else {
@@ -128,6 +189,17 @@ export async function main(argv = process.argv.slice(2)) {
         process.stdout.write(`${VERSION}\n`);
         return;
     }
+    if (args.print) {
+        printDocument({
+            path: args.open,
+            width: args.sidebar,
+            theme: args.theme,
+            color: args.color,
+            flavor: args.flavor,
+            spoilers: args.spoilers,
+        });
+        return;
+    }
     if (!process.stdout.isTTY) {
         process.stderr.write("readm3: needs a terminal. Try `readm3 --help`.\n");
         process.exitCode = 1;

package/dist/cli.js.map

@@ -1 +1 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,GAAG,EAAsB,MAAM,aAAa,CAAC;AAEtD,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC;AAE/B,MAAM,KAAK,GAAG;;;;;;;;;8CASgC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;;;;;;;;;;;;;CAcpF,CAAC;AAOF,MAAM,UAAW,SAAQ,KAAK;CAAG;AAEjC,MAAM,UAAU,SAAS,CAAC,IAAc;IACtC,MAAM,MAAM,GAAe;QACzB,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE;QACnB,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,KAAK;QACd,KAAK,EAAE,IAAI;QACX,GAAG,EAAE,KAAK;KACX,CAAC;IACF,IAAI,MAA0B,CAAC;IAE/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAW,CAAC;QAC9B,MAAM,IAAI,GAAG,GAAW,EAAE;YACxB,MAAM,KAAK,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;YACxB,IAAI,KAAK,KAAK,SAAS;gBAAE,MAAM,IAAI,UAAU,CAAC,GAAG,GAAG,gBAAgB,CAAC,CAAC;YACtE,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QAEF,QAAQ,GAAG,EAAE,CAAC;YACZ,KAAK,IAAI,CAAC;YACV,KAAK,QAAQ;gBACX,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;gBACnB,MAAM;YACR,KAAK,IAAI,CAAC;YACV,KAAK,WAAW;gBACd,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;gBACtB,MAAM;YACR,KAAK,IAAI,CAAC;YACV,KAAK,SAAS;gBACZ,MAAM,CAAC,KAAK,GAAG,IAAI,EAAE,CAAC;gBACtB,MAAM;YACR,KAAK,IAAI,CAAC;YACV,KAAK,SAAS,CAAC,CAAC,CAAC;gBACf,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;gBAC1C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC;oBAAE,MAAM,IAAI,UAAU,CAAC,iCAAiC,CAAC,CAAC;gBACnG,MAAM,CAAC,OAAO,GAAG,KAAK,CAAC;gBACvB,MAAM;YACR,CAAC;YACD,KAAK,IAAI,CAAC;YACV,KAAK,OAAO;gBACV,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC;gBAClB,MAAM;YACR,KAAK,IAAI,CAAC;YACV,KAAK,YAAY;gBACf,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;gBACrB,MAAM;YACR;gBACE,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,GAAG,KAAK,GAAG;oBAAE,MAAM,IAAI,UAAU,CAAC,mBAAmB,GAAG,EAAE,CAAC,CAAC;gBACvF,IAAI,MAAM,KAAK,SAAS;oBAAE,MAAM,IAAI,UAAU,CAAC,4BAA4B,CAAC,CAAC;gBAC7E,MAAM,GAAG,GAAG,CAAC;gBACb,MAAM;QACV,CAAC;IACH,CAAC;IAED,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAC7B,IAAI,KAAc,CAAC;QACnB,IAAI,CAAC;YACH,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;QACvC,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,UAAU,CAAC,8BAA8B,MAAM,EAAE,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;YAC5B,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;QACrB,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,OAAiB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/D,IAAI,IAAgB,CAAC;IACrB,IAAI,CAAC;QACH,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;YAChC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,KAAK,CAAC,OAAO,OAAO,KAAK,EAAE,CAAC,CAAC;YAC7D,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,OAAO;QACT,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5B,OAAO;IACT,CAAC;IACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC;QACrC,OAAO;IACT,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QAC1B,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACzE,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;QACrB,OAAO;IACT,CAAC;IAED,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC;AAClB,CAAC;AAED,iFAAiF;AACjF,gFAAgF;AAChF,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC/E,KAAK,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;QACnC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACpF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAe,MAAM,cAAc,CAAC;AAC9D,OAAO,EAAE,aAAa,EAAE,WAAW,EAAkB,MAAM,YAAY,CAAC;AACxE,OAAO,EAAE,GAAG,EAAsB,MAAM,aAAa,CAAC;AAEtD,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC;AAE/B,+EAA+E;AAC/E,MAAM,CAAC,MAAM,KAAK,GAAG;;;;;;;;;;;;;8CAayB,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;;;mDAIlC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;CAyBpE,CAAC;AAYF,MAAM,UAAW,SAAQ,KAAK;CAAG;AAEjC,MAAM,UAAU,SAAS,CAAC,IAAc;IACtC,MAAM,MAAM,GAAe;QACzB,IAAI,EAAE,OAAO,CAAC,GAAG,EAAE;QACnB,IAAI,EAAE,KAAK;QACX,OAAO,EAAE,KAAK;QACd,KAAK,EAAE,KAAK;QACZ,KAAK,EAAE,MAAM;QACb,QAAQ,EAAE,KAAK;QACf,KAAK,EAAE,IAAI;QACX,GAAG,EAAE,KAAK;QACV,QAAQ,EAAE,KAAK;KAChB,CAAC;IACF,IAAI,MAA0B,CAAC;IAE/B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAW,CAAC;QAC9B,MAAM,IAAI,GAAG,GAAW,EAAE;YACxB,MAAM,KAAK,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;YACxB,IAAI,KAAK,KAAK,SAAS;gBAAE,MAAM,IAAI,UAAU,CAAC,GAAG,GAAG,gBAAgB,CAAC,CAAC;YACtE,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QAEF,QAAQ,GAAG,EAAE,CAAC;YACZ,KAAK,IAAI,CAAC;YACV,KAAK,QAAQ;gBACX,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;gBACnB,MAAM;YACR,KAAK,IAAI,CAAC;YACV,KAAK,WAAW;gBACd,MAAM,CAAC,OAAO,GAAG,IAAI,CAAC;gBACtB,MAAM;YACR,KAAK,IAAI,CAAC;YACV,KAAK,SAAS;gBACZ,MAAM,CAAC,KAAK,GAAG,IAAI,EAAE,CAAC;gBACtB,MAAM;YACR,KAAK,IAAI,CAAC;YACV,KAAK,SAAS,CAAC,CAAC,CAAC;gBACf,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;gBAC1C,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC;oBAAE,MAAM,IAAI,UAAU,CAAC,iCAAiC,CAAC,CAAC;gBACnG,MAAM,CAAC,OAAO,GAAG,KAAK,CAAC;gBACvB,MAAM;YACR,CAAC;YACD,KAAK,IAAI,CAAC;YACV,KAAK,SAAS;gBACZ,MAAM,CAAC,KAAK,GAAG,IAAI,CAAC;gBACpB,MAAM;YACR,KAAK,SAAS,CAAC,CAAC,CAAC;gBACf,MAAM,KAAK,GAAG,IAAI,EAAe,CAAC;gBAClC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;oBACjC,MAAM,IAAI,UAAU,CAAC,2BAA2B,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAC5E,CAAC;gBACD,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;gBACrB,MAAM;YACR,CAAC;YACD,KAAK,IAAI,CAAC;YACV,KAAK,UAAU,CAAC,CAAC,CAAC;gBAChB,MAAM,KAAK,GAAG,IAAI,EAAE,CAAC;gBACrB,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;oBACrB,MAAM,IAAI,UAAU,CAAC,4BAA4B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBACzE,CAAC;gBACD,MAAM,CAAC,MAAM,GAAG,KAAsB,CAAC;gBACvC,MAAM;YACR,CAAC;YACD,KAAK,YAAY;gBACf,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;gBACvB,MAAM;YACR,KAAK,IAAI,CAAC;YACV,KAAK,aAAa;gBAChB,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;gBACvB,MAAM;YACR,KAAK,IAAI,CAAC;YACV,KAAK,OAAO;gBACV,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC;gBAClB,MAAM;YACR,KAAK,IAAI,CAAC;YACV,KAAK,YAAY;gBACf,MAAM,CAAC,KAAK,GAAG,KAAK,CAAC;gBACrB,MAAM;YACR;gBACE,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,GAAG,KAAK,GAAG;oBAAE,MAAM,IAAI,UAAU,CAAC,mBAAmB,GAAG,EAAE,CAAC,CAAC;gBACvF,IAAI,MAAM,KAAK,SAAS;oBAAE,MAAM,IAAI,UAAU,CAAC,4BAA4B,CAAC,CAAC;gBAC7E,MAAM,GAAG,GAAG,CAAC;gBACb,MAAM;QACV,CAAC;IACH,CAAC;IAED,IAAI,MAAM,KAAK,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,MAAM,CAAC,KAAK;YAAE,MAAM,IAAI,UAAU,CAAC,mCAAmC,CAAC,CAAC;QAC7E,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;QAC7B,IAAI,KAAc,CAAC;QACnB,IAAI,CAAC;YACH,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC;QACvC,CAAC;QAAC,MAAM,CAAC;YACP,MAAM,IAAI,UAAU,CAAC,8BAA8B,MAAM,EAAE,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,MAAM,CAAC,KAAK;gBAAE,MAAM,IAAI,UAAU,CAAC,uCAAuC,CAAC,CAAC;YAChF,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;QACrB,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;YAC5B,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC;QACrB,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,OAAiB,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC/D,IAAI,IAAgB,CAAC;IACrB,IAAI,CAAC;QACH,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,UAAU,EAAE,CAAC;YAChC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,KAAK,CAAC,OAAO,OAAO,KAAK,EAAE,CAAC,CAAC;YAC7D,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,OAAO;QACT,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5B,OAAO;IACT,CAAC;IACD,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC;QACrC,OAAO;IACT,CAAC;IACD,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACf,aAAa,CAAC;YACZ,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,OAAO;YACnB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC,CAAC;QACH,OAAO;IACT,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QAC1B,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,kDAAkD,CAAC,CAAC;QACzE,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;QACrB,OAAO;IACT,CAAC;IAED,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC;AAClB,CAAC;AAED,iFAAiF;AACjF,gFAAgF;AAChF,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC/E,KAAK,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;QACnC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACpF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/editor.d.ts

@@ -0,0 +1,77 @@
+/**
+ * The edit buffer: lines, a caret, and undo.
+ *
+ * Nothing here touches a terminal. The viewer owns the keys and the drawing;
+ * this owns what the text is, which is the part worth testing — the same split
+ * `markdown.ts` makes between parsing and painting.
+ *
+ * Functions mutate the state they are given and return it. A buffer is a few
+ * thousand lines at most, but copying the array on every keystroke to look
+ * functional would buy nothing a snapshot in `undo` does not already give.
+ */
+/** What the last edit was, so a run of typing collapses into one undo step. */
+export type EditKind = "none" | "insert" | "delete" | "newline" | "other";
+export interface Snapshot {
+    lines: string[];
+    row: number;
+    col: number;
+}
+export interface Editor {
+    lines: string[];
+    row: number;
+    col: number;
+    /** Column to aim for on vertical motion, so crossing a short line keeps place. */
+    goal: number;
+    dirty: boolean;
+    undo: Snapshot[];
+    redo: Snapshot[];
+    last: EditKind;
+}
+export declare function createEditor(source: string): Editor;
+/** The buffer as one string. Round-trips whatever `createEditor` was given. */
+export declare function text(ed: Editor): string;
+export declare function lineAt(ed: Editor, row: number): string;
+/** Break the current undo run, so the next edit starts a new step. */
+export declare function breakRun(ed: Editor): Editor;
+export declare function undo(ed: Editor): Editor;
+export declare function redo(ed: Editor): Editor;
+export declare function moveLeft(ed: Editor): Editor;
+export declare function moveRight(ed: Editor): Editor;
+/** Vertical motion aims at `goal`, so a short line in the way is passed over. */
+export declare function moveVertical(ed: Editor, delta: number): Editor;
+export declare const moveUp: (ed: Editor) => Editor;
+export declare const moveDown: (ed: Editor) => Editor;
+/** Home, but to the first non-blank first — the second press goes to column 0. */
+export declare function moveHome(ed: Editor): Editor;
+export declare function moveEnd(ed: Editor): Editor;
+export declare function moveDocStart(ed: Editor): Editor;
+export declare function moveDocEnd(ed: Editor): Editor;
+export declare function moveWordLeft(ed: Editor): Editor;
+export declare function moveWordRight(ed: Editor): Editor;
+/** Insert text at the caret. Newlines in it split lines, so paste works. */
+export declare function insert(ed: Editor, str: string): Editor;
+/**
+ * The prefix a new line should inherit: the indent, and the list marker when
+ * the caret is leaving one.
+ *
+ * Returns `null` for an item that has no content, which is the signal to clear
+ * it instead — pressing enter twice is how a list ends.
+ */
+export declare function continuation(line: string): {
+    prefix: string;
+    clear: boolean;
+};
+/** Split the line at the caret, carrying indentation and list markers over. */
+export declare function newline(ed: Editor): Editor;
+export declare function backspace(ed: Editor): Editor;
+/** Delete forward. Joins the next line when the caret is at the end. */
+export declare function del(ed: Editor): Editor;
+/** Delete to the end of the line, or join the next when already there. */
+export declare function killToLineEnd(ed: Editor): Editor;
+/** Delete from the caret back to the start of the line's text. */
+export declare function killToLineStart(ed: Editor): Editor;
+/** Two spaces, the indent the renderer reads back as one list level. */
+export declare function indent(ed: Editor): Editor;
+/** Mark the buffer as matching what is on disk. */
+export declare function markSaved(ed: Editor): Editor;
+//# sourceMappingURL=editor.d.ts.map

package/dist/editor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"editor.d.ts","sourceRoot":"","sources":["../src/editor.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAKH,+EAA+E;AAC/E,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,OAAO,CAAC;AAE1E,MAAM,WAAW,QAAQ;IACvB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,MAAM;IACrB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,kFAAkF;IAClF,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,QAAQ,EAAE,CAAC;IACjB,IAAI,EAAE,QAAQ,EAAE,CAAC;IACjB,IAAI,EAAE,QAAQ,CAAC;CAChB;AAOD,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAWnD;AAED,+EAA+E;AAC/E,wBAAgB,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAEvC;AAED,wBAAgB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAEtD;AAoCD,sEAAsE;AACtE,wBAAgB,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAG3C;AAED,wBAAgB,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAUvC;AAED,wBAAgB,IAAI,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAUvC;AAID,wBAAgB,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAQ3C;AAED,wBAAgB,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAQ5C;AAED,iFAAiF;AACjF,wBAAgB,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAK9D;AAED,eAAO,MAAM,MAAM,GAAI,IAAI,MAAM,KAAG,MAA8B,CAAC;AACnE,eAAO,MAAM,QAAQ,GAAI,IAAI,MAAM,KAAG,MAA6B,CAAC;AAEpE,kFAAkF;AAClF,wBAAgB,QAAQ,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAK3C;AAED,wBAAgB,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAI1C;AAED,wBAAgB,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAK/C;AAED,wBAAgB,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAK7C;AAID,wBAAgB,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAS/C;AAED,wBAAgB,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAShD;AAID,4EAA4E;AAC5E,wBAAgB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAqBtD;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAkB7E;AAED,+EAA+E;AAC/E,wBAAgB,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAqB1C;AAED,wBAAgB,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAkB5C;AAED,wEAAwE;AACxE,wBAAgB,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAUtC;AAED,0EAA0E;AAC1E,wBAAgB,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAMhD;AAED,kEAAkE;AAClE,wBAAgB,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAMlD;AAED,wEAAwE;AACxE,wBAAgB,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAEzC;AAED,mDAAmD;AACnD,wBAAgB,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAI5C"}