@profullstack/readm3 0.2.0 → 0.3.0

package/dist/flavors.js

@@ -0,0 +1,223 @@
+/**
+ * Markdown flavors, as marked extensions.
+ *
+ * marked handles CommonMark and GFM — tables, task lists, strikethrough and
+ * bare-URL autolinks — so what lives here is only what GitHub and Reddit added
+ * on top and marked does not ship: footnotes, alerts, spoilers, superscript,
+ * subreddit and user links, and `:shortcode:` emoji.
+ *
+ * Every extension is a tokenizer only. readm3 never renders HTML: it walks the
+ * token tree itself in `markdown.ts` and emits styled spans, so a `renderer` on
+ * these would be dead weight.
+ */
+import { Lexer, Marked } from "marked";
+import { emojiFor } from "./emoji.js";
+export const FLAVORS = ["commonmark", "github", "reddit", "all"];
+export const DEFAULT_FLAVOR = "github";
+export function isFlavor(value) {
+    return FLAVORS.includes(value);
+}
+/* ------------------------------------------------------------- footnotes --- */
+/** `[^1]: the note`, with indented continuation lines folded in. */
+const footnoteDef = {
+    name: "footnoteDef",
+    level: "block",
+    start(src) {
+        const m = /^\[\^[^\]\n]+\]:/m.exec(src);
+        return m ? m.index : undefined;
+    },
+    tokenizer(src) {
+        const m = /^\[\^([^\]\n]+)\]:[ \t]*([^\n]*(?:\n(?:[ \t]+[^\n]*|[ \t]*(?=\n)))*)/.exec(src);
+        if (!m)
+            return undefined;
+        const body = (m[2] ?? "")
+            .split("\n")
+            .map((line) => line.replace(/^(?: {1,4}|\t)/, ""))
+            .join("\n")
+            .trim();
+        return {
+            type: "footnoteDef",
+            raw: m[0],
+            label: m[1],
+            tokens: this.lexer.blockTokens(body ? `${body}\n` : "\n"),
+        };
+    },
+};
+/** `[^1]` in running text. Must out-run the link tokenizer, so it is an extension. */
+const footnoteRef = {
+    name: "footnoteRef",
+    level: "inline",
+    start(src) {
+        const i = src.indexOf("[^");
+        return i < 0 ? undefined : i;
+    },
+    tokenizer(src) {
+        const m = /^\[\^([^\]\n]+)\]/.exec(src);
+        if (!m)
+            return undefined;
+        return { type: "footnoteRef", raw: m[0], label: m[1] };
+    },
+};
+/* -------------------------------------------------------------- reddit --- */
+/** `>!spoiler!<`. */
+const spoiler = {
+    name: "spoiler",
+    level: "inline",
+    start(src) {
+        const i = src.indexOf(">!");
+        return i < 0 ? undefined : i;
+    },
+    tokenizer(src) {
+        const m = /^>!([\s\S]+?)!</.exec(src);
+        if (!m)
+            return undefined;
+        return {
+            type: "spoiler",
+            raw: m[0],
+            text: m[1],
+            tokens: this.lexer.inlineTokens(m[1]),
+        };
+    },
+};
+/**
+ * A paragraph opening with `>!`, claimed before the blockquote tokenizer sees it.
+ *
+ * `>` starts a blockquote in every other dialect, so without this a spoiler at
+ * the start of a line is quoted and its `>!` is eaten. Reddit reads the spoiler,
+ * and so do we — but only under a flavor that asked for it.
+ */
+const spoilerParagraph = {
+    name: "spoilerParagraph",
+    level: "block",
+    start(src) {
+        const m = /^>!/m.exec(src);
+        return m ? m.index : undefined;
+    },
+    tokenizer(src) {
+        if (!src.startsWith(">!"))
+            return undefined;
+        const m = /^[^\n]+(?:\n(?!\s*\n)[^\n]+)*/.exec(src);
+        if (!m)
+            return undefined;
+        const text = m[0];
+        return {
+            type: "paragraph",
+            raw: text,
+            text,
+            tokens: this.lexer.inlineTokens(text),
+        };
+    },
+};
+/** `^(a phrase)` or `^word`. */
+const superscript = {
+    name: "superscript",
+    level: "inline",
+    start(src) {
+        const i = src.indexOf("^");
+        return i < 0 ? undefined : i;
+    },
+    tokenizer(src) {
+        const m = /^\^\(([^)\n]+)\)|^\^([^\s^()]+)/.exec(src);
+        if (!m)
+            return undefined;
+        const text = (m[1] ?? m[2] ?? "").trim();
+        if (!text)
+            return undefined;
+        return { type: "superscript", raw: m[0], text, tokens: this.lexer.inlineTokens(text) };
+    },
+};
+/**
+ * `r/subreddit` and `u/user`, with or without a leading slash.
+ *
+ * `start` carries the word-boundary check because a tokenizer only ever sees
+ * the source from a position marked, and `foo/r/bar` must not qualify.
+ */
+const redditLink = {
+    name: "redditLink",
+    level: "inline",
+    start(src) {
+        const m = /(^|[^\w/])(\/?[ru]\/[A-Za-z0-9][A-Za-z0-9_-]{1,})/.exec(src);
+        return m ? m.index + m[1].length : undefined;
+    },
+    tokenizer(src) {
+        const m = /^\/?([ru])\/([A-Za-z0-9][A-Za-z0-9_-]{1,})/.exec(src);
+        if (!m)
+            return undefined;
+        return {
+            type: "redditLink",
+            raw: m[0],
+            kind: m[1],
+            name: m[2],
+            href: `https://www.reddit.com/${m[1]}/${m[2]}/`,
+        };
+    },
+};
+/* --------------------------------------------------------------- emoji --- */
+/** `:tada:`, left as written when the name is not one we know. */
+const emoji = {
+    name: "emoji",
+    level: "inline",
+    start(src) {
+        const i = src.indexOf(":");
+        return i < 0 ? undefined : i;
+    },
+    tokenizer(src) {
+        const m = /^:([a-z0-9_+-]+):/.exec(src);
+        if (!m)
+            return undefined;
+        const glyph = emojiFor(m[1]);
+        if (glyph === null)
+            return undefined;
+        return { type: "emoji", raw: m[0], text: glyph };
+    },
+};
+/* -------------------------------------------------------------- lexers --- */
+const GITHUB = [footnoteDef, footnoteRef, emoji];
+const REDDIT = [spoilerParagraph, spoiler, superscript, redditLink];
+function extensionsFor(flavor) {
+    switch (flavor) {
+        case "commonmark":
+            return [];
+        case "github":
+            return GITHUB;
+        case "reddit":
+            return REDDIT;
+        case "all":
+            return [...GITHUB, ...REDDIT];
+    }
+}
+const cache = new Map();
+/**
+ * The configured marked instance for a flavor. Cached: building one walks every
+ * extension, and a resize re-renders the open document as its width changes.
+ */
+export function lexerFor(flavor = DEFAULT_FLAVOR) {
+    const hit = cache.get(flavor);
+    if (hit)
+        return hit;
+    const extensions = extensionsFor(flavor);
+    const marked = new Marked({ gfm: flavor !== "commonmark", breaks: false });
+    if (extensions.length > 0)
+        marked.use({ extensions });
+    cache.set(flavor, marked);
+    return marked;
+}
+/**
+ * A fresh Lexer carrying the flavor's options.
+ *
+ * `Marked#lexer` is a bound helper, not the lexer itself, and the extension
+ * tokenizers need `this.lexer` to recurse — so the Lexer is built here from the
+ * instance defaults rather than reached for through the facade.
+ */
+function lexer(flavor) {
+    return new Lexer(lexerFor(flavor).defaults);
+}
+/** Block tokens for a source string, under a flavor. */
+export function lex(source, flavor = DEFAULT_FLAVOR) {
+    return lexer(flavor).lex(source);
+}
+/** Inline tokens for a fragment, under a flavor. */
+export function lexInline(source, flavor = DEFAULT_FLAVOR) {
+    return lexer(flavor).inlineTokens(source);
+}
+//# sourceMappingURL=flavors.js.map

package/dist/flavors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"flavors.js","sourceRoot":"","sources":["../src/flavors.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,OAAO,EAAE,KAAK,EAAE,MAAM,EAAwE,MAAM,QAAQ,CAAC;AAC7G,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAqDtC,MAAM,CAAC,MAAM,OAAO,GAAa,CAAC,YAAY,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC;AAE3E,MAAM,CAAC,MAAM,cAAc,GAAW,QAAQ,CAAC;AAE/C,MAAM,UAAU,QAAQ,CAAC,KAAa;IACpC,OAAQ,OAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC/C,CAAC;AAED,iFAAiF;AAEjF,oEAAoE;AACpE,MAAM,WAAW,GAAkC;IACjD,IAAI,EAAE,aAAa;IACnB,KAAK,EAAE,OAAO;IACd,KAAK,CAAC,GAAW;QACf,MAAM,CAAC,GAAG,mBAAmB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IACjC,CAAC;IACD,SAAS,CAAC,GAAW;QACnB,MAAM,CAAC,GAAG,sEAAsE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3F,IAAI,CAAC,CAAC;YAAE,OAAO,SAAS,CAAC;QACzB,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;aACtB,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;aACjD,IAAI,CAAC,IAAI,CAAC;aACV,IAAI,EAAE,CAAC;QACV,OAAO;YACL,IAAI,EAAE,aAAa;YACnB,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;YACT,KAAK,EAAE,CAAC,CAAC,CAAC,CAAW;YACrB,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAY;SACrE,CAAC;IACJ,CAAC;CACF,CAAC;AAEF,sFAAsF;AACtF,MAAM,WAAW,GAAkC;IACjD,IAAI,EAAE,aAAa;IACnB,KAAK,EAAE,QAAQ;IACf,KAAK,CAAC,GAAW;QACf,MAAM,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/B,CAAC;IACD,SAAS,CAAC,GAAW;QACnB,MAAM,CAAC,GAAG,mBAAmB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,CAAC,CAAC;YAAE,OAAO,SAAS,CAAC;QACzB,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAW,EAAE,CAAC;IACnE,CAAC;CACF,CAAC;AAEF,+EAA+E;AAE/E,qBAAqB;AACrB,MAAM,OAAO,GAAkC;IAC7C,IAAI,EAAE,SAAS;IACf,KAAK,EAAE,QAAQ;IACf,KAAK,CAAC,GAAW;QACf,MAAM,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC5B,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/B,CAAC;IACD,SAAS,CAAC,GAAW;QACnB,MAAM,CAAC,GAAG,iBAAiB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,CAAC;YAAE,OAAO,SAAS,CAAC;QACzB,OAAO;YACL,IAAI,EAAE,SAAS;YACf,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;YACT,IAAI,EAAE,CAAC,CAAC,CAAC,CAAW;YACpB,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAW,CAAY;SAC3D,CAAC;IACJ,CAAC;CACF,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,gBAAgB,GAAkC;IACtD,IAAI,EAAE,kBAAkB;IACxB,KAAK,EAAE,OAAO;IACd,KAAK,CAAC,GAAW;QACf,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3B,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;IACjC,CAAC;IACD,SAAS,CAAC,GAAW;QACnB,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC;YAAE,OAAO,SAAS,CAAC;QAC5C,MAAM,CAAC,GAAG,+BAA+B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACpD,IAAI,CAAC,CAAC;YAAE,OAAO,SAAS,CAAC;QACzB,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,CAAW,CAAC;QAC5B,OAAO;YACL,IAAI,EAAE,WAAW;YACjB,GAAG,EAAE,IAAI;YACT,IAAI;YACJ,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAY;SACjD,CAAC;IACJ,CAAC;CACF,CAAC;AAEF,gCAAgC;AAChC,MAAM,WAAW,GAAkC;IACjD,IAAI,EAAE,aAAa;IACnB,KAAK,EAAE,QAAQ;IACf,KAAK,CAAC,GAAW;QACf,MAAM,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3B,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/B,CAAC;IACD,SAAS,CAAC,GAAW;QACnB,MAAM,CAAC,GAAG,iCAAiC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtD,IAAI,CAAC,CAAC;YAAE,OAAO,SAAS,CAAC;QACzB,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QACzC,IAAI,CAAC,IAAI;YAAE,OAAO,SAAS,CAAC;QAC5B,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,CAAY,EAAE,CAAC;IACpG,CAAC;CACF,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,GAAkC;IAChD,IAAI,EAAE,YAAY;IAClB,KAAK,EAAE,QAAQ;IACf,KAAK,CAAC,GAAW;QACf,MAAM,CAAC,GAAG,mDAAmD,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,GAAI,CAAC,CAAC,CAAC,CAAY,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3D,CAAC;IACD,SAAS,CAAC,GAAW;QACnB,MAAM,CAAC,GAAG,4CAA4C,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjE,IAAI,CAAC,CAAC;YAAE,OAAO,SAAS,CAAC;QACzB,OAAO;YACL,IAAI,EAAE,YAAY;YAClB,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;YACT,IAAI,EAAE,CAAC,CAAC,CAAC,CAAW;YACpB,IAAI,EAAE,CAAC,CAAC,CAAC,CAAW;YACpB,IAAI,EAAE,0BAA0B,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG;SAChD,CAAC;IACJ,CAAC;CACF,CAAC;AAEF,+EAA+E;AAE/E,kEAAkE;AAClE,MAAM,KAAK,GAAkC;IAC3C,IAAI,EAAE,OAAO;IACb,KAAK,EAAE,QAAQ;IACf,KAAK,CAAC,GAAW;QACf,MAAM,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3B,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/B,CAAC;IACD,SAAS,CAAC,GAAW;QACnB,MAAM,CAAC,GAAG,mBAAmB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,CAAC,CAAC;YAAE,OAAO,SAAS,CAAC;QACzB,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAW,CAAC,CAAC;QACvC,IAAI,KAAK,KAAK,IAAI;YAAE,OAAO,SAAS,CAAC;QACrC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IACnD,CAAC;CACF,CAAC;AAEF,+EAA+E;AAE/E,MAAM,MAAM,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;AACjD,MAAM,MAAM,GAAG,CAAC,gBAAgB,EAAE,OAAO,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;AAEpE,SAAS,aAAa,CAAC,MAAc;IACnC,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,YAAY;YACf,OAAO,EAAE,CAAC;QACZ,KAAK,QAAQ;YACX,OAAO,MAAM,CAAC;QAChB,KAAK,QAAQ;YACX,OAAO,MAAM,CAAC;QAChB,KAAK,KAAK;YACR,OAAO,CAAC,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC,CAAC;IAClC,CAAC;AACH,CAAC;AAED,MAAM,KAAK,GAAG,IAAI,GAAG,EAAkB,CAAC;AAExC;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,SAAiB,cAAc;IACtD,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAC9B,IAAI,GAAG;QAAE,OAAO,GAAG,CAAC;IACpB,MAAM,UAAU,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;IACzC,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,EAAE,GAAG,EAAE,MAAM,KAAK,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;IAC3E,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,CAAC,GAAG,CAAC,EAAE,UAAU,EAAqB,CAAC,CAAC;IACzE,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1B,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,KAAK,CAAC,MAAc;IAC3B,OAAO,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,CAAC;AAC9C,CAAC;AAED,wDAAwD;AACxD,MAAM,UAAU,GAAG,CAAC,MAAc,EAAE,SAAiB,cAAc;IACjE,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,MAAM,CAAY,CAAC;AAC9C,CAAC;AAED,oDAAoD;AACpD,MAAM,UAAU,SAAS,CAAC,MAAc,EAAE,SAAiB,cAAc;IACvE,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,MAAM,CAAY,CAAC;AACvD,CAAC"}

package/dist/index.d.ts

@@ -1,11 +1,16 @@
 /**
- * readm3 — a terminal markdown reader.
+ * readm3 — a terminal markdown reader and editor.
  *
- * The renderer and the file tree are exported so they can be reused: both are
- * pure, and neither needs a terminal.
+ * The renderer, the file tree and the edit buffer are exported so they can be
+ * reused: all three are pure, and none of them needs a terminal.
  */
 export { renderMarkdown, parseInline, wrapSpans, mergeSpans, normalizeHtml, plain, toText } from "./markdown.ts";
-export type { Line, Span, Role } from "./markdown.ts";
+export type { Line, Span, Role, RenderOptions } from "./markdown.ts";
+export { FLAVORS, DEFAULT_FLAVOR, isFlavor, lex, lexInline, lexerFor } from "./flavors.ts";
+export type { Flavor } from "./flavors.ts";
+export { EMOJI, emojiFor } from "./emoji.ts";
+export { createEditor, text, lineAt, continuation, insert, newline, backspace, del, killToLineEnd, killToLineStart, indent, undo, redo, breakRun, markSaved, moveLeft, moveRight, moveUp, moveDown, moveVertical, moveHome, moveEnd, moveDocStart, moveDocEnd, moveWordLeft, moveWordRight, } from "./editor.ts";
+export type { Editor, EditKind, Snapshot } from "./editor.ts";
 export { scan, flatten, files, filterTree, matches, reveal, indexOfPath, label, MARKDOWN, DEFAULT_IGNORE, } from "./tree.ts";
 export type { Entry, FlatEntry, ScanOptions } from "./tree.ts";
 export { colorOf } from "./roles.ts";
@@ -13,6 +18,6 @@ export { printDocument, renderAnsi, styleSpan, colorParams, resolveDepth, resolv
 export type { PrintOptions, ColorMode } from "./print.ts";
 export { run } from "./viewer.ts";
 export type { ViewerOptions } from "./viewer.ts";
-export { main, parseArgs, VERSION } from "./cli.ts";
+export { main, parseArgs, USAGE, VERSION } from "./cli.ts";
 export type { ParsedArgs } from "./cli.ts";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACjH,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EACL,IAAI,EACJ,OAAO,EACP,KAAK,EACL,UAAU,EACV,OAAO,EACP,MAAM,EACN,WAAW,EACX,KAAK,EACL,QAAQ,EACR,cAAc,GACf,MAAM,WAAW,CAAC;AACnB,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EACL,aAAa,EACb,UAAU,EACV,SAAS,EACT,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,WAAW,GACZ,MAAM,YAAY,CAAC;AACpB,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAClC,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACpD,YAAY,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACjH,YAAY,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AACrE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAC3F,YAAY,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EACL,YAAY,EACZ,IAAI,EACJ,MAAM,EACN,YAAY,EACZ,MAAM,EACN,OAAO,EACP,SAAS,EACT,GAAG,EACH,aAAa,EACb,eAAe,EACf,MAAM,EACN,IAAI,EACJ,IAAI,EACJ,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,SAAS,EACT,MAAM,EACN,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,OAAO,EACP,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,aAAa,GACd,MAAM,aAAa,CAAC;AACrB,YAAY,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC9D,OAAO,EACL,IAAI,EACJ,OAAO,EACP,KAAK,EACL,UAAU,EACV,OAAO,EACP,MAAM,EACN,WAAW,EACX,KAAK,EACL,QAAQ,EACR,cAAc,GACf,MAAM,WAAW,CAAC;AACnB,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAC/D,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EACL,aAAa,EACb,UAAU,EACV,SAAS,EACT,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,WAAW,GACZ,MAAM,YAAY,CAAC;AACpB,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC1D,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAClC,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAC3D,YAAY,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC"}

package/dist/index.js

@@ -1,13 +1,16 @@
 /**
- * readm3 — a terminal markdown reader.
+ * readm3 — a terminal markdown reader and editor.
  *
- * The renderer and the file tree are exported so they can be reused: both are
- * pure, and neither needs a terminal.
+ * The renderer, the file tree and the edit buffer are exported so they can be
+ * reused: all three are pure, and none of them needs a terminal.
  */
 export { renderMarkdown, parseInline, wrapSpans, mergeSpans, normalizeHtml, plain, toText } from "./markdown.js";
+export { FLAVORS, DEFAULT_FLAVOR, isFlavor, lex, lexInline, lexerFor } from "./flavors.js";
+export { EMOJI, emojiFor } from "./emoji.js";
+export { createEditor, text, lineAt, continuation, insert, newline, backspace, del, killToLineEnd, killToLineStart, indent, undo, redo, breakRun, markSaved, moveLeft, moveRight, moveUp, moveDown, moveVertical, moveHome, moveEnd, moveDocStart, moveDocEnd, moveWordLeft, moveWordRight, } from "./editor.js";
 export { scan, flatten, files, filterTree, matches, reveal, indexOfPath, label, MARKDOWN, DEFAULT_IGNORE, } from "./tree.js";
 export { colorOf } from "./roles.js";
 export { printDocument, renderAnsi, styleSpan, colorParams, resolveDepth, resolveWidth, COLOR_MODES, } from "./print.js";
 export { run } from "./viewer.js";
-export { main, parseArgs, VERSION } from "./cli.js";
+export { main, parseArgs, USAGE, VERSION } from "./cli.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEjH,OAAO,EACL,IAAI,EACJ,OAAO,EACP,KAAK,EACL,UAAU,EACV,OAAO,EACP,MAAM,EACN,WAAW,EACX,KAAK,EACL,QAAQ,EACR,cAAc,GACf,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EACL,aAAa,EACb,UAAU,EACV,SAAS,EACT,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,WAAW,GACZ,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAElC,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEjH,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE3F,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EACL,YAAY,EACZ,IAAI,EACJ,MAAM,EACN,YAAY,EACZ,MAAM,EACN,OAAO,EACP,SAAS,EACT,GAAG,EACH,aAAa,EACb,eAAe,EACf,MAAM,EACN,IAAI,EACJ,IAAI,EACJ,QAAQ,EACR,SAAS,EACT,QAAQ,EACR,SAAS,EACT,MAAM,EACN,QAAQ,EACR,YAAY,EACZ,QAAQ,EACR,OAAO,EACP,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,aAAa,GACd,MAAM,aAAa,CAAC;AAErB,OAAO,EACL,IAAI,EACJ,OAAO,EACP,KAAK,EACL,UAAU,EACV,OAAO,EACP,MAAM,EACN,WAAW,EACX,KAAK,EACL,QAAQ,EACR,cAAc,GACf,MAAM,WAAW,CAAC;AAEnB,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AACrC,OAAO,EACL,aAAa,EACb,UAAU,EACV,SAAS,EACT,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,WAAW,GACZ,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,GAAG,EAAE,MAAM,aAAa,CAAC;AAElC,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC"}

package/dist/markdown.d.ts

@@ -1,4 +1,5 @@
-export type Role = "text" | "h1" | "h2" | "h3" | "code" | "fence" | "gutter" | "lang" | "link" | "url" | "quote" | "bullet" | "rule" | "meta" | "th";
+import { type Flavor } from "./flavors.ts";
+export type Role = "text" | "h1" | "h2" | "h3" | "code" | "fence" | "gutter" | "lang" | "link" | "url" | "quote" | "bullet" | "rule" | "meta" | "th" | "spoiler" | "sup" | "footnote" | "alert-note" | "alert-tip" | "alert-important" | "alert-warning" | "alert-caution";
 export interface Span {
     text: string;
     role?: Role;
@@ -6,11 +7,18 @@ export interface Span {
     italic?: boolean;
     underline?: boolean;
     dim?: boolean;
+    strike?: boolean;
 }
 export interface Line {
     spans: Span[];
 }
 type Style = Omit<Span, "text">;
+export interface RenderOptions {
+    /** Which dialect's extras to honor. Defaults to GitHub. */
+    flavor?: Flavor | undefined;
+    /** Show spoiler text rather than blocking it out. */
+    spoilers?: boolean | undefined;
+}
 /**
  * Glue neighbouring spans that share a style back together.
  *
@@ -29,7 +37,8 @@ export declare function toText(lines: Line[]): string[];
  * Inline code is held out of this: `Array<string>` must survive tag stripping.
  */
 export declare function normalizeHtml(src: string): string;
-export declare function parseInline(src: string, base?: Style): Span[];
+/** Inline markdown to spans. Exported because the site and tests both want it. */
+export declare function parseInline(src: string, base?: Style, options?: RenderOptions): Span[];
 /** Greedy word wrap that carries each word's styling with it. */
 export declare function wrapSpans(spans: Span[], width: number, first?: number, hanging?: number): Line[];
 /**
@@ -38,6 +47,6 @@ export declare function wrapSpans(spans: Span[], width: number, first?: number,
  * `width` is the pane's interior, so a resize re-renders rather than reflows —
  * cheap, and it keeps tables and code gutters honest.
  */
-export declare function renderMarkdown(source: string, width: number): Line[];
+export declare function renderMarkdown(source: string, width: number, options?: RenderOptions): Line[];
 export {};
 //# sourceMappingURL=markdown.d.ts.map

package/dist/markdown.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../src/markdown.ts"],"names":[],"mappings":"AASA,MAAM,MAAM,IAAI,GACZ,MAAM,GACN,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,MAAM,GACN,OAAO,GACP,QAAQ,GACR,MAAM,GACN,MAAM,GACN,KAAK,GACL,OAAO,GACP,QAAQ,GACR,MAAM,GACN,MAAM,GACN,IAAI,CAAC;AAET,MAAM,WAAW,IAAI;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,GAAG,CAAC,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAED,KAAK,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AAyBhC;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,CAQhD;AAED,4EAA4E;AAC5E,wBAAgB,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAExC;AAED,gCAAgC;AAChC,wBAAgB,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAE9C;AAuDD;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAKjD;AAoBD,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,KAAU,GAAG,IAAI,EAAE,CAEjE;AAkGD,iEAAiE;AACjE,wBAAgB,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,SAAI,EAAE,OAAO,SAAQ,GAAG,IAAI,EAAE,CAyD1F;AA0FD;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,EAAE,CAiOpE"}
+{"version":3,"file":"markdown.d.ts","sourceRoot":"","sources":["../src/markdown.ts"],"names":[],"mappings":"AAcA,OAAO,EAKL,KAAK,MAAM,EAMZ,MAAM,cAAc,CAAC;AAEtB,MAAM,MAAM,IAAI,GACZ,MAAM,GACN,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,MAAM,GACN,OAAO,GACP,QAAQ,GACR,MAAM,GACN,MAAM,GACN,KAAK,GACL,OAAO,GACP,QAAQ,GACR,MAAM,GACN,MAAM,GACN,IAAI,GACJ,SAAS,GACT,KAAK,GACL,UAAU,GACV,YAAY,GACZ,WAAW,GACX,iBAAiB,GACjB,eAAe,GACf,eAAe,CAAC;AAEpB,MAAM,WAAW,IAAI;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,IAAI;IACnB,KAAK,EAAE,IAAI,EAAE,CAAC;CACf;AAED,KAAK,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AAEhC,MAAM,WAAW,aAAa;IAC5B,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,qDAAqD;IACrD,QAAQ,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;CAChC;AAwCD;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,CAQhD;AAED,4EAA4E;AAC5E,wBAAgB,KAAK,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAExC;AAED,gCAAgC;AAChC,wBAAgB,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,MAAM,EAAE,CAE9C;AAID;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAKjD;AAgKD,kFAAkF;AAClF,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,KAAU,EAAE,OAAO,GAAE,aAAkB,GAAG,IAAI,EAAE,CAG9F;AAID,iEAAiE;AACjE,wBAAgB,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,SAAI,EAAE,OAAO,SAAQ,GAAG,IAAI,EAAE,CAyD1F;AAkVD;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,GAAE,aAAkB,GAAG,IAAI,EAAE,CA+BjG"}