@localix-ai/flowdown 0.0.0-stage → 0.5.0

package/dist/tui/code.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Highlighted HTML for `code`, or null for a language it does not know: the shape `<Markdown
+ * highlight>` and the other targets take.
+ */
+export type Highlighter = (code: string, language: string) => string | null;

package/dist/tui/code.js

@@ -0,0 +1,240 @@
+import { printable } from "./printable.js";
+import { CODE, DIM, DONE, FAILED, PLAIN, patch } from "./style.js";
+import { span, tabPads, untabbed } from "./wrap.js";
+// src/tui/code.ts
+/**
+* A fence's code as rows, coloured by a highlighter when the terminal was given one.
+*
+* The highlighter is the one a page takes (`@localix-ai/flowdown/highlight`, or any function of that
+* shape): it returns HTML, spans named by highlight.js's classes. A terminal has no HTML, so the
+* spans are read here for what they say, a token's kind, and each kind is drawn in one of the few
+* colours a terminal theme can be trusted with.
+*
+* What a highlighter returns is not trusted with the text. The tokens are drawn only when, put
+* together, they are the code that was given, character for character; otherwise the code is
+* drawn plain, as without a highlighter. So highlighting changes the colours of a row and never
+* its text, its width or where it breaks.
+*
+* A reply that streams draws its last block again on every token, and a highlighter is the dear
+* part of that. So a view keeps a {@link CodeDrawer}: a fence it has coloured is not coloured
+* again while its code is the same, and the fence still being written is coloured in pieces, of
+* which only the last is new.
+*/
+/** How each kind of token is drawn; a kind not listed is drawn as what holds it. */
+const KINDS = {
+	comment: DIM,
+	quote: DIM,
+	keyword: { color: "magenta" },
+	"selector-tag": { color: "magenta" },
+	doctag: { color: "magenta" },
+	name: { color: "magenta" },
+	string: { color: "green" },
+	regexp: { color: "green" },
+	number: { color: "yellow" },
+	literal: { color: "yellow" },
+	variable: { color: "yellow" },
+	"template-variable": { color: "yellow" },
+	attr: { color: "yellow" },
+	attribute: { color: "yellow" },
+	symbol: { color: "yellow" },
+	bullet: { color: "yellow" },
+	title: { bold: true },
+	section: { bold: true },
+	type: { color: "cyan" },
+	built_in: { color: "cyan" },
+	meta: { color: "cyan" },
+	"selector-id": { color: "cyan" },
+	"selector-class": { color: "cyan" },
+	addition: { color: "green" },
+	deletion: { color: "red" },
+	emphasis: { italic: true },
+	strong: { bold: true }
+};
+/** A class's name: `class Queue`, where a function's is only bold. */
+const CLASS_TITLE = { color: "cyan" };
+/** The style of a span with these classes inside text drawn as `outer`; null when none names a kind. */
+function styleOf(classes, outer) {
+	const names = classes.split(/\s+/);
+	const kind = names.find((name) => name.startsWith("hljs-"))?.slice(5);
+	if (kind === void 0) return null;
+	if (kind === "subst") return PLAIN;
+	if (kind === "title" && names.includes("class_")) return patch(outer, CLASS_TITLE);
+	const style = KINDS[kind];
+	return style ? patch(outer, style) : null;
+}
+const ENTITIES = {
+	amp: "&",
+	lt: "<",
+	gt: ">",
+	quot: "\"",
+	apos: "'"
+};
+/** `&amp;` as `&`; an entity that names no character is the text it is. */
+function entity(whole, body) {
+	if (body[0] !== "#") return ENTITIES[body] ?? whole;
+	const code = /^#x/i.test(body) ? Number.parseInt(body.slice(2), 16) : Number(body.slice(1));
+	return Number.isInteger(code) && code >= 0 && code <= 1114111 ? String.fromCodePoint(code) : whole;
+}
+const MARKUP = /<(\/?)([A-Za-z][^\s/>]*)(?:\s+class\s*=\s*"([^"]*)"|\s[^>]*)?\s*\/?>|&(#[xX][0-9A-Fa-f]+|#[0-9]+|[A-Za-z]+);/g;
+/**
+* A highlighter's HTML as tokens: the text between the tags, each piece with the style of the
+* spans around it. `known` says whether any span named a kind this module draws.
+*/
+function tokens(html) {
+	const out = [];
+	const open = [PLAIN];
+	let known = false;
+	let text = "";
+	const flush = () => {
+		if (text) out.push([text, open.at(-1)]);
+		text = "";
+	};
+	let at = 0;
+	for (const match of html.matchAll(MARKUP)) {
+		text += html.slice(at, match.index);
+		at = match.index + match[0].length;
+		const [whole, closes, tag, classes, body] = match;
+		if (tag === void 0) {
+			text += entity(whole, body);
+			continue;
+		}
+		flush();
+		if (closes) {
+			if (open.length > 1) open.pop();
+			continue;
+		}
+		const style = classes === void 0 ? null : styleOf(classes, open.at(-1));
+		if (style) known = true;
+		open.push(style ?? open.at(-1));
+	}
+	text += html.slice(at);
+	flush();
+	return {
+		tokens: out,
+		known
+	};
+}
+/** The languages whose lines say what they are by their first character. */
+const DIFFS = /* @__PURE__ */ new Set(["diff", "patch"]);
+/** What a line of a diff is drawn in: what it adds, what it takes away, where it is. */
+function diffStyle(line) {
+	if (line.startsWith("@@")) return DIM;
+	if (line.startsWith("+")) return DONE;
+	if (line.startsWith("-")) return FAILED;
+	return CODE;
+}
+/**
+* `source` as it is drawn without a highlighter: in the one colour of code, and a diff by its
+* lines, which takes no grammar to read.
+*/
+function plain(source, language) {
+	const diff = language != null && DIFFS.has(language.toLowerCase());
+	return source.split("\n").map((line) => [span(printable(untabbed(line)), diff ? diffStyle(line) : CODE)]);
+}
+/**
+* The rows of a fence's `source`, not yet cut to a width: one per line of code. With a
+* highlighter that knows `language`, each token in its colour; otherwise all of it as code.
+*/
+function codeRows(source, language, highlight) {
+	if (!highlight || !language) return plain(source, language);
+	let read;
+	try {
+		const html = highlight(source, language);
+		if (html === null) return plain(source, language);
+		read = tokens(html);
+	} catch {
+		return plain(source, language);
+	}
+	if (!read.known || read.tokens.map(([text]) => text).join("") !== source) return plain(source, language);
+	/** The pads of the tabs in the line of code that starts at `from`. */
+	const padsFrom = (from) => {
+		const end = source.indexOf("\n", from);
+		return tabPads(source.slice(from, end === -1 ? void 0 : end));
+	};
+	const rows = [[]];
+	let pads = padsFrom(0);
+	let line = 0;
+	let offset = 0;
+	for (const [text, style] of read.tokens) {
+		let piece = "";
+		const put = () => {
+			if (piece) rows.at(-1).push(span(printable(piece), style));
+			piece = "";
+		};
+		for (const char of text) {
+			offset += char.length;
+			if (char === "\n") {
+				put();
+				rows.push([]);
+				pads = padsFrom(offset);
+				line = 0;
+			} else if (char === "	") piece += " ".repeat(pads[line++]);
+			else piece += char;
+		}
+		put();
+	}
+	return rows;
+}
+/** The drawer of a view with this highlighter. Without one there is nothing to keep. */
+function createCodeDrawer(highlight) {
+	if (!highlight) return {
+		rows: (source, language) => plain(source, language),
+		pieced: () => false,
+		turn() {}
+	};
+	const pieces = [];
+	let tail = null;
+	/** The last piece, when it is all of its fence. */
+	let only = null;
+	let cut = false;
+	let now = /* @__PURE__ */ new Map();
+	let before = /* @__PURE__ */ new Map();
+	const whole = (source, language) => {
+		const key = `${language}\u0000${source}`;
+		let rows = now.get(key) ?? before.get(key);
+		if (rows === void 0 && only?.text === source && only.language === language) rows = only.rows;
+		if (rows === void 0) rows = codeRows(source, language, highlight);
+		now.set(key, rows);
+		return rows;
+	};
+	const piece = (kept, text, language) => kept && kept.text === text && kept.language === language ? kept : {
+		language,
+		text,
+		rows: codeRows(text, language, highlight)
+	};
+	const growing = (source, language) => {
+		const lines = source.split("\n");
+		const out = [];
+		let index = 0;
+		for (let at = 0; at < lines.length; at += 40, index++) {
+			const text = lines.slice(at, at + 40).join("\n");
+			const last = at + 40 >= lines.length;
+			const made = piece(last ? tail : pieces[index] ?? tail, text, language);
+			if (last) tail = made;
+			else pieces[index] = made;
+			for (const row of made.rows) out.push(row);
+		}
+		pieces.length = index - 1;
+		only = index === 1 ? tail : null;
+		if (index > 1) cut = true;
+		return out;
+	};
+	return {
+		rows(source, language, open) {
+			if (!language) return plain(source);
+			return open ? growing(source, language) : whole(source, language);
+		},
+		pieced() {
+			const was = cut;
+			cut = false;
+			return was;
+		},
+		turn() {
+			before = now;
+			now = /* @__PURE__ */ new Map();
+		}
+	};
+}
+export { codeRows, createCodeDrawer };
+
+//# sourceMappingURL=code.js.map

package/dist/tui/code.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"code.js","names":[],"sources":["../../src/tui/code.ts"],"sourcesContent":["/**\n * A fence's code as rows, coloured by a highlighter when the terminal was given one.\n *\n * The highlighter is the one a page takes (`@localix-ai/flowdown/highlight`, or any function of that\n * shape): it returns HTML, spans named by highlight.js's classes. A terminal has no HTML, so the\n * spans are read here for what they say, a token's kind, and each kind is drawn in one of the few\n * colours a terminal theme can be trusted with.\n *\n * What a highlighter returns is not trusted with the text. The tokens are drawn only when, put\n * together, they are the code that was given, character for character; otherwise the code is\n * drawn plain, as without a highlighter. So highlighting changes the colours of a row and never\n * its text, its width or where it breaks.\n *\n * A reply that streams draws its last block again on every token, and a highlighter is the dear\n * part of that. So a view keeps a {@link CodeDrawer}: a fence it has coloured is not coloured\n * again while its code is the same, and the fence still being written is coloured in pieces, of\n * which only the last is new.\n */\nimport { printable } from './printable'\nimport { CODE, DIM, DONE, FAILED, PLAIN, patch, type Line, type Style } from './style'\nimport { span, tabPads, untabbed } from './wrap'\n\n/**\n * Highlighted HTML for `code`, or null for a language it does not know: the shape `<Markdown\n * highlight>` and the other targets take.\n */\nexport type Highlighter = (code: string, language: string) => string | null\n\n/** How each kind of token is drawn; a kind not listed is drawn as what holds it. */\nconst KINDS: Record<string, Style> = {\n  comment: DIM,\n  quote: DIM,\n  keyword: { color: 'magenta' },\n  'selector-tag': { color: 'magenta' },\n  doctag: { color: 'magenta' },\n  name: { color: 'magenta' },\n  string: { color: 'green' },\n  regexp: { color: 'green' },\n  number: { color: 'yellow' },\n  literal: { color: 'yellow' },\n  variable: { color: 'yellow' },\n  'template-variable': { color: 'yellow' },\n  attr: { color: 'yellow' },\n  attribute: { color: 'yellow' },\n  symbol: { color: 'yellow' },\n  bullet: { color: 'yellow' },\n  title: { bold: true },\n  section: { bold: true },\n  type: { color: 'cyan' },\n  built_in: { color: 'cyan' },\n  meta: { color: 'cyan' },\n  'selector-id': { color: 'cyan' },\n  'selector-class': { color: 'cyan' },\n  addition: { color: 'green' },\n  deletion: { color: 'red' },\n  emphasis: { italic: true },\n  strong: { bold: true },\n}\n\n/** A class's name: `class Queue`, where a function's is only bold. */\nconst CLASS_TITLE: Style = { color: 'cyan' }\n\n/** The style of a span with these classes inside text drawn as `outer`; null when none names a kind. */\nfunction styleOf(classes: string, outer: Style): Style | null {\n  const names = classes.split(/\\s+/)\n  const kind = names.find((name) => name.startsWith('hljs-'))?.slice(5)\n  if (kind === undefined) return null\n  // Code inside a string (`${…}`) is code again, not string.\n  if (kind === 'subst') return PLAIN\n  if (kind === 'title' && names.includes('class_')) return patch(outer, CLASS_TITLE)\n  const style = KINDS[kind]\n  return style ? patch(outer, style) : null\n}\n\nconst ENTITIES: Record<string, string> = { amp: '&', lt: '<', gt: '>', quot: '\"', apos: \"'\" }\n\n/** `&amp;` as `&`; an entity that names no character is the text it is. */\nfunction entity(whole: string, body: string): string {\n  if (body[0] !== '#') return ENTITIES[body] ?? whole\n  const code = /^#x/i.test(body) ? Number.parseInt(body.slice(2), 16) : Number(body.slice(1))\n  return Number.isInteger(code) && code >= 0 && code <= 0x10ffff\n    ? String.fromCodePoint(code)\n    : whole\n}\n\ntype Token = [text: string, style: Style]\n\nconst MARKUP =\n  /<(\\/?)([A-Za-z][^\\s/>]*)(?:\\s+class\\s*=\\s*\"([^\"]*)\"|\\s[^>]*)?\\s*\\/?>|&(#[xX][0-9A-Fa-f]+|#[0-9]+|[A-Za-z]+);/g\n\n/**\n * A highlighter's HTML as tokens: the text between the tags, each piece with the style of the\n * spans around it. `known` says whether any span named a kind this module draws.\n */\nfunction tokens(html: string): { tokens: Token[]; known: boolean } {\n  const out: Token[] = []\n  const open: Style[] = [PLAIN]\n  let known = false\n  let text = ''\n  const flush = (): void => {\n    if (text) out.push([text, open.at(-1)!])\n    text = ''\n  }\n  let at = 0\n  for (const match of html.matchAll(MARKUP)) {\n    text += html.slice(at, match.index)\n    at = match.index + match[0].length\n    const [whole, closes, tag, classes, body] = match\n    if (tag === undefined) {\n      text += entity(whole, body!)\n      continue\n    }\n    flush()\n    if (closes) {\n      if (open.length > 1) open.pop()\n      continue\n    }\n    const style = classes === undefined ? null : styleOf(classes, open.at(-1)!)\n    if (style) known = true\n    open.push(style ?? open.at(-1)!)\n  }\n  text += html.slice(at)\n  flush()\n  return { tokens: out, known }\n}\n\n/** The languages whose lines say what they are by their first character. */\nconst DIFFS = new Set(['diff', 'patch'])\n\n/** What a line of a diff is drawn in: what it adds, what it takes away, where it is. */\nfunction diffStyle(line: string): Style {\n  if (line.startsWith('@@')) return DIM\n  if (line.startsWith('+')) return DONE\n  if (line.startsWith('-')) return FAILED\n  return CODE\n}\n\n/**\n * `source` as it is drawn without a highlighter: in the one colour of code, and a diff by its\n * lines, which takes no grammar to read.\n */\nfunction plain(source: string, language?: string | null): Line[] {\n  const diff = language != null && DIFFS.has(language.toLowerCase())\n  return source\n    .split('\\n')\n    .map((line) => [span(printable(untabbed(line)), diff ? diffStyle(line) : CODE)])\n}\n\n/**\n * The rows of a fence's `source`, not yet cut to a width: one per line of code. With a\n * highlighter that knows `language`, each token in its colour; otherwise all of it as code.\n */\nexport function codeRows(\n  source: string,\n  language: string | null | undefined,\n  highlight: Highlighter | null,\n): Line[] {\n  if (!highlight || !language) return plain(source, language)\n  let read: ReturnType<typeof tokens>\n  try {\n    const html = highlight(source, language)\n    if (html === null) return plain(source, language)\n    read = tokens(html)\n  } catch {\n    // A grammar that fails on this code costs the colours, not the reply.\n    return plain(source, language)\n  }\n  // Colours from classes this module does not know (a highlighter with a scheme of its own) are\n  // no colours here; and tokens that are not the code are not drawn at all.\n  if (!read.known || read.tokens.map(([text]) => text).join('') !== source)\n    return plain(source, language)\n\n  /** The pads of the tabs in the line of code that starts at `from`. */\n  const padsFrom = (from: number): number[] => {\n    const end = source.indexOf('\\n', from)\n    return tabPads(source.slice(from, end === -1 ? undefined : end))\n  }\n  const rows: Line[] = [[]]\n  let pads = padsFrom(0)\n  let line = 0\n  let offset = 0\n  for (const [text, style] of read.tokens) {\n    let piece = ''\n    const put = (): void => {\n      if (piece) rows.at(-1)!.push(span(printable(piece), style))\n      piece = ''\n    }\n    for (const char of text) {\n      offset += char.length\n      if (char === '\\n') {\n        put()\n        rows.push([])\n        pads = padsFrom(offset)\n        line = 0\n      } else if (char === '\\t') {\n        piece += ' '.repeat(pads[line++]!)\n      } else {\n        piece += char\n      }\n    }\n    put()\n  }\n  return rows\n}\n\n/** The lines of a piece of a fence still being written: what is highlighted at once. */\nexport const PIECE_LINES = 40\n\n/** A fence's rows for one view, which draws the same code many times while a reply streams. */\nexport interface CodeDrawer {\n  /**\n   * The rows of a fence's `source`, one per line of code. `growing` says the fence may still be\n   * written to: it is highlighted in pieces of {@link PIECE_LINES} lines, each on its own, so a\n   * token costs the last piece and not the whole fence. A construct that runs over two pieces (a\n   * block comment, a template string) may be coloured wrongly until the fence is done; then it\n   * is highlighted whole. The pieces are a matter of colour only: the text is the code.\n   */\n  rows(source: string, language: string | null | undefined, growing: boolean): Line[]\n  /** Whether a fence was drawn in more than one piece since this was last asked. */\n  pieced(): boolean\n  /** A render is over: the fences it did not draw are forgotten. */\n  turn(): void\n}\n\ninterface Piece {\n  language: string\n  text: string\n  rows: Line[]\n}\n\n/** The drawer of a view with this highlighter. Without one there is nothing to keep. */\nexport function createCodeDrawer(highlight: Highlighter | null): CodeDrawer {\n  if (!highlight)\n    return { rows: (source, language) => plain(source, language), pieced: () => false, turn() {} }\n  // The pieces of the fence being written that have all their lines, in order; and its last one,\n  // which a token that changed nothing in it, or that only began the next, finds as it was.\n  const pieces: Piece[] = []\n  let tail: Piece | null = null\n  /** The last piece, when it is all of its fence. */\n  let only: Piece | null = null\n  let cut = false\n  // Finished fences, by language and code: those of this render, and those of the last.\n  let now = new Map<string, Line[]>()\n  let before = new Map<string, Line[]>()\n  const whole = (source: string, language: string): Line[] => {\n    const key = `${language}\\u0000${source}`\n    let rows = now.get(key) ?? before.get(key)\n    // A fence that was all one piece while it was written is already drawn whole.\n    if (rows === undefined && only?.text === source && only.language === language) rows = only.rows\n    if (rows === undefined) rows = codeRows(source, language, highlight)\n    now.set(key, rows)\n    return rows\n  }\n  const piece = (kept: Piece | null | undefined, text: string, language: string): Piece =>\n    kept && kept.text === text && kept.language === language\n      ? kept\n      : { language, text, rows: codeRows(text, language, highlight) }\n  const growing = (source: string, language: string): Line[] => {\n    const lines = source.split('\\n')\n    const out: Line[] = []\n    let index = 0\n    for (let at = 0; at < lines.length; at += PIECE_LINES, index++) {\n      const text = lines.slice(at, at + PIECE_LINES).join('\\n')\n      // The last piece may still gain a line, or the end of its last one.\n      const last = at + PIECE_LINES >= lines.length\n      const made = piece(last ? tail : (pieces[index] ?? tail), text, language)\n      if (last) tail = made\n      else pieces[index] = made\n      for (const row of made.rows) out.push(row)\n    }\n    pieces.length = index - 1\n    only = index === 1 ? tail : null\n    if (index > 1) cut = true\n    return out\n  }\n  return {\n    rows(source, language, open) {\n      if (!language) return plain(source)\n      return open ? growing(source, language) : whole(source, language)\n    },\n    pieced() {\n      const was = cut\n      cut = false\n      return was\n    },\n    turn() {\n      before = now\n      now = new Map()\n    },\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AA6BA,MAAM,QAA+B;CACnC,SAAS;CACT,OAAO;CACP,SAAS,EAAE,OAAO,UAAU;CAC5B,gBAAgB,EAAE,OAAO,UAAU;CACnC,QAAQ,EAAE,OAAO,UAAU;CAC3B,MAAM,EAAE,OAAO,UAAU;CACzB,QAAQ,EAAE,OAAO,QAAQ;CACzB,QAAQ,EAAE,OAAO,QAAQ;CACzB,QAAQ,EAAE,OAAO,SAAS;CAC1B,SAAS,EAAE,OAAO,SAAS;CAC3B,UAAU,EAAE,OAAO,SAAS;CAC5B,qBAAqB,EAAE,OAAO,SAAS;CACvC,MAAM,EAAE,OAAO,SAAS;CACxB,WAAW,EAAE,OAAO,SAAS;CAC7B,QAAQ,EAAE,OAAO,SAAS;CAC1B,QAAQ,EAAE,OAAO,SAAS;CAC1B,OAAO,EAAE,MAAM,KAAK;CACpB,SAAS,EAAE,MAAM,KAAK;CACtB,MAAM,EAAE,OAAO,OAAO;CACtB,UAAU,EAAE,OAAO,OAAO;CAC1B,MAAM,EAAE,OAAO,OAAO;CACtB,eAAe,EAAE,OAAO,OAAO;CAC/B,kBAAkB,EAAE,OAAO,OAAO;CAClC,UAAU,EAAE,OAAO,QAAQ;CAC3B,UAAU,EAAE,OAAO,MAAM;CACzB,UAAU,EAAE,QAAQ,KAAK;CACzB,QAAQ,EAAE,MAAM,KAAK;AACvB;;AAGA,MAAM,cAAqB,EAAE,OAAO,OAAO;;AAG3C,SAAS,QAAQ,SAAiB,OAA4B;CAC5D,MAAM,QAAQ,QAAQ,MAAM,KAAK;CACjC,MAAM,OAAO,MAAM,MAAM,SAAS,KAAK,WAAW,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC;CACpE,IAAI,SAAS,KAAA,GAAW,OAAO;CAE/B,IAAI,SAAS,SAAS,OAAO;CAC7B,IAAI,SAAS,WAAW,MAAM,SAAS,QAAQ,GAAG,OAAO,MAAM,OAAO,WAAW;CACjF,MAAM,QAAQ,MAAM;CACpB,OAAO,QAAQ,MAAM,OAAO,KAAK,IAAI;AACvC;AAEA,MAAM,WAAmC;CAAE,KAAK;CAAK,IAAI;CAAK,IAAI;CAAK,MAAM;CAAK,MAAM;AAAI;;AAG5F,SAAS,OAAO,OAAe,MAAsB;CACnD,IAAI,KAAK,OAAO,KAAK,OAAO,SAAS,SAAS;CAC9C,MAAM,OAAO,OAAO,KAAK,IAAI,IAAI,OAAO,SAAS,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,OAAO,KAAK,MAAM,CAAC,CAAC;CAC1F,OAAO,OAAO,UAAU,IAAI,KAAK,QAAQ,KAAK,QAAQ,UAClD,OAAO,cAAc,IAAI,IACzB;AACN;AAIA,MAAM,SACJ;;;;;AAMF,SAAS,OAAO,MAAmD;CACjE,MAAM,MAAe,CAAC;CACtB,MAAM,OAAgB,CAAC,KAAK;CAC5B,IAAI,QAAQ;CACZ,IAAI,OAAO;CACX,MAAM,cAAoB;EACxB,IAAI,MAAM,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,EAAE,CAAE,CAAC;EACvC,OAAO;CACT;CACA,IAAI,KAAK;CACT,KAAK,MAAM,SAAS,KAAK,SAAS,MAAM,GAAG;EACzC,QAAQ,KAAK,MAAM,IAAI,MAAM,KAAK;EAClC,KAAK,MAAM,QAAQ,MAAM,EAAE,CAAC;EAC5B,MAAM,CAAC,OAAO,QAAQ,KAAK,SAAS,QAAQ;EAC5C,IAAI,QAAQ,KAAA,GAAW;GACrB,QAAQ,OAAO,OAAO,IAAK;GAC3B;EACF;EACA,MAAM;EACN,IAAI,QAAQ;GACV,IAAI,KAAK,SAAS,GAAG,KAAK,IAAI;GAC9B;EACF;EACA,MAAM,QAAQ,YAAY,KAAA,IAAY,OAAO,QAAQ,SAAS,KAAK,GAAG,EAAE,CAAE;EAC1E,IAAI,OAAO,QAAQ;EACnB,KAAK,KAAK,SAAS,KAAK,GAAG,EAAE,CAAE;CACjC;CACA,QAAQ,KAAK,MAAM,EAAE;CACrB,MAAM;CACN,OAAO;EAAE,QAAQ;EAAK;CAAM;AAC9B;;AAGA,MAAM,wBAAQ,IAAI,IAAI,CAAC,QAAQ,OAAO,CAAC;;AAGvC,SAAS,UAAU,MAAqB;CACtC,IAAI,KAAK,WAAW,IAAI,GAAG,OAAO;CAClC,IAAI,KAAK,WAAW,GAAG,GAAG,OAAO;CACjC,IAAI,KAAK,WAAW,GAAG,GAAG,OAAO;CACjC,OAAO;AACT;;;;;AAMA,SAAS,MAAM,QAAgB,UAAkC;CAC/D,MAAM,OAAO,YAAY,QAAQ,MAAM,IAAI,SAAS,YAAY,CAAC;CACjE,OAAO,OACJ,MAAM,IAAI,CAAC,CACX,KAAK,SAAS,CAAC,KAAK,UAAU,SAAS,IAAI,CAAC,GAAG,OAAO,UAAU,IAAI,IAAI,IAAI,CAAC,CAAC;AACnF;;;;;AAMA,SAAgB,SACd,QACA,UACA,WACQ;CACR,IAAI,CAAC,aAAa,CAAC,UAAU,OAAO,MAAM,QAAQ,QAAQ;CAC1D,IAAI;CACJ,IAAI;EACF,MAAM,OAAO,UAAU,QAAQ,QAAQ;EACvC,IAAI,SAAS,MAAM,OAAO,MAAM,QAAQ,QAAQ;EAChD,OAAO,OAAO,IAAI;CACpB,QAAQ;EAEN,OAAO,MAAM,QAAQ,QAAQ;CAC/B;CAGA,IAAI,CAAC,KAAK,SAAS,KAAK,OAAO,KAAK,CAAC,UAAU,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,QAChE,OAAO,MAAM,QAAQ,QAAQ;;CAG/B,MAAM,YAAY,SAA2B;EAC3C,MAAM,MAAM,OAAO,QAAQ,MAAM,IAAI;EACrC,OAAO,QAAQ,OAAO,MAAM,MAAM,QAAQ,KAAK,KAAA,IAAY,GAAG,CAAC;CACjE;CACA,MAAM,OAAe,CAAC,CAAC,CAAC;CACxB,IAAI,OAAO,SAAS,CAAC;CACrB,IAAI,OAAO;CACX,IAAI,SAAS;CACb,KAAK,MAAM,CAAC,MAAM,UAAU,KAAK,QAAQ;EACvC,IAAI,QAAQ;EACZ,MAAM,YAAkB;GACtB,IAAI,OAAO,KAAK,GAAG,EAAE,CAAC,CAAE,KAAK,KAAK,UAAU,KAAK,GAAG,KAAK,CAAC;GAC1D,QAAQ;EACV;EACA,KAAK,MAAM,QAAQ,MAAM;GACvB,UAAU,KAAK;GACf,IAAI,SAAS,MAAM;IACjB,IAAI;IACJ,KAAK,KAAK,CAAC,CAAC;IACZ,OAAO,SAAS,MAAM;IACtB,OAAO;GACT,OAAO,IAAI,SAAS,KAClB,SAAS,IAAI,OAAO,KAAK,OAAQ;QAEjC,SAAS;EAEb;EACA,IAAI;CACN;CACA,OAAO;AACT;;AA4BA,SAAgB,iBAAiB,WAA2C;CAC1E,IAAI,CAAC,WACH,OAAO;EAAE,OAAO,QAAQ,aAAa,MAAM,QAAQ,QAAQ;EAAG,cAAc;EAAO,OAAO,CAAC;CAAE;CAG/F,MAAM,SAAkB,CAAC;CACzB,IAAI,OAAqB;;CAEzB,IAAI,OAAqB;CACzB,IAAI,MAAM;CAEV,IAAI,sBAAM,IAAI,IAAoB;CAClC,IAAI,yBAAS,IAAI,IAAoB;CACrC,MAAM,SAAS,QAAgB,aAA6B;EAC1D,MAAM,MAAM,GAAG,SAAS,QAAQ;EAChC,IAAI,OAAO,IAAI,IAAI,GAAG,KAAK,OAAO,IAAI,GAAG;EAEzC,IAAI,SAAS,KAAA,KAAa,MAAM,SAAS,UAAU,KAAK,aAAa,UAAU,OAAO,KAAK;EAC3F,IAAI,SAAS,KAAA,GAAW,OAAO,SAAS,QAAQ,UAAU,SAAS;EACnE,IAAI,IAAI,KAAK,IAAI;EACjB,OAAO;CACT;CACA,MAAM,SAAS,MAAgC,MAAc,aAC3D,QAAQ,KAAK,SAAS,QAAQ,KAAK,aAAa,WAC5C,OACA;EAAE;EAAU;EAAM,MAAM,SAAS,MAAM,UAAU,SAAS;CAAE;CAClE,MAAM,WAAW,QAAgB,aAA6B;EAC5D,MAAM,QAAQ,OAAO,MAAM,IAAI;EAC/B,MAAM,MAAc,CAAC;EACrB,IAAI,QAAQ;EACZ,KAAK,IAAI,KAAK,GAAG,KAAK,MAAM,QAAQ,MAAA,IAAmB,SAAS;GAC9D,MAAM,OAAO,MAAM,MAAM,IAAI,KAAA,EAAgB,CAAC,CAAC,KAAK,IAAI;GAExD,MAAM,OAAO,KAAA,MAAoB,MAAM;GACvC,MAAM,OAAO,MAAM,OAAO,OAAQ,OAAO,UAAU,MAAO,MAAM,QAAQ;GACxE,IAAI,MAAM,OAAO;QACZ,OAAO,SAAS;GACrB,KAAK,MAAM,OAAO,KAAK,MAAM,IAAI,KAAK,GAAG;EAC3C;EACA,OAAO,SAAS,QAAQ;EACxB,OAAO,UAAU,IAAI,OAAO;EAC5B,IAAI,QAAQ,GAAG,MAAM;EACrB,OAAO;CACT;CACA,OAAO;EACL,KAAK,QAAQ,UAAU,MAAM;GAC3B,IAAI,CAAC,UAAU,OAAO,MAAM,MAAM;GAClC,OAAO,OAAO,QAAQ,QAAQ,QAAQ,IAAI,MAAM,QAAQ,QAAQ;EAClE;EACA,SAAS;GACP,MAAM,MAAM;GACZ,MAAM;GACN,OAAO;EACT;EACA,OAAO;GACL,SAAS;GACT,sBAAM,IAAI,IAAI;EAChB;CACF;AACF"}

package/dist/tui/index.d.ts

@@ -0,0 +1,54 @@
+import { Extension, Node } from "../engine/types.js";
+import { Highlighter } from "./code.js";
+import { DEFAULT_LABELS, MIN_WIDTH, TerminalLabels } from "./render.js";
+import { Colour, Line, Span, Style, lineText, sgr, toAnsi } from "./style.js";
+import { printable } from "./printable.js";
+import { width } from "./width.js";
+import { lineWidth } from "./wrap.js";
+/** The words the renderer adds, any of them replaced. */
+export type TerminalLabelOverrides = Partial<Omit<TerminalLabels, 'callouts'>> & {
+  callouts?: Partial<TerminalLabels['callouts']>;
+};
+export interface TerminalOptions {
+  /** The columns of the terminal; 80 when not given, and never under 8. */
+  width?: number;
+  /** Your own syntax, after the dialect's (`Extension`). A node the renderer does not know is drawn as its text. */
+  extensions?: Extension[];
+  /** The words the renderer adds (callout names), for a terminal in another language. */
+  labels?: TerminalLabelOverrides;
+  /**
+   * Colour fenced code: `@localix-ai/flowdown/highlight`, or any function that returns highlight.js's
+   * HTML. Off by default; a language it does not know is drawn in the one colour of code.
+   */
+  highlight?: Highlighter | null;
+  /**
+   * Read `$…$`, `$$…$$` and a `math` fence as formulas and write them in Unicode: `x^2` as `x²`,
+   * `\frac{a}{b}` as `a/b`. On by default; `false` leaves them as the text they were written as.
+   */
+  math?: boolean;
+}
+export interface RenderOptions {
+  /** The text is a reply still arriving: its unfinished end is completed. */
+  streaming?: boolean;
+  /** The terminal was resized: draw for this width from now on. */
+  width?: number;
+}
+export interface TerminalView {
+  /**
+   * The rows for `text`. The rows of a block that did not change are the same objects as at the
+   * last render: a screen that compares by identity repaints only what is new.
+   */
+  render(text: string, options?: RenderOptions): Line[];
+}
+/** One text drawn more than once: a reply while it streams. */
+export declare function createTerminalView(options?: TerminalOptions): TerminalView;
+/** `markdown` as terminal rows. */
+export declare function renderToLines(markdown: string, options?: TerminalOptions & RenderOptions): Line[];
+/**
+ * `markdown` as text for a terminal, rows parted by `\n`. `color: false` leaves the escape
+ * sequences out: for a pipe, a file, a terminal that asked for none (`NO_COLOR`).
+ */
+export declare function renderToAnsi(markdown: string, options?: TerminalOptions & RenderOptions & {
+  color?: boolean;
+}): string;
+export { type Colour, DEFAULT_LABELS, type Extension, type Highlighter, type Line, MIN_WIDTH, type Node, type Span, type Style, type TerminalLabels, lineText, lineWidth, printable, sgr, width as textWidth, toAnsi };

package/dist/tui/index.js

@@ -0,0 +1,99 @@
+import { mathSyntax } from "../core/math-syntax.js";
+import { flowdownDialect } from "../core/remark-answer-blocks.js";
+import { createDocument } from "../document/index.js";
+import { parse } from "../engine/index.js";
+import { createCodeDrawer } from "./code.js";
+import { DEFAULT_LABELS, MIN_WIDTH, drawBlock } from "./render.js";
+import { lineText, sgr, toAnsi } from "./style.js";
+import { printable } from "./printable.js";
+import { width } from "./width.js";
+import { lineWidth } from "./wrap.js";
+// src/tui/index.ts
+/**
+* `@localix-ai/flowdown/tui`: Markdown as the rows of a terminal.
+*
+*     import { renderToAnsi } from '@localix-ai/flowdown/tui'
+*
+*     process.stdout.write(renderToAnsi(reply, { width: process.stdout.columns }) + '\n')
+*
+* The same text every other target reads, parsed by the same parser with the same dialect, and
+* drawn in a terminal's terms: words wrapped to the width by the columns they take, tables in
+* columns, a callout behind a coloured bar, steps down a numbered rail. No row is wider than the
+* width, and nothing a reply holds reaches the terminal as an instruction to it (`printable.ts`).
+*
+* A reply still arriving is drawn with a view, which keeps what it drew: each token costs the
+* block it lands in, and the rows of every block before it are the very same objects.
+*
+*     const view = createTerminalView({ width: 80 })
+*     for await (const text of reply) draw(view.render(text, { streaming: true }))
+*     draw(view.render(text))
+*
+* The rows are plain values (`Line`, a list of `{ text, style }`): `toAnsi` writes them for a
+* terminal, and a TUI library with a screen of its own reads them as they are.
+*/
+const DEFAULT_WIDTH = 80;
+/** One text drawn more than once: a reply while it streams. */
+function createTerminalView(options = {}) {
+	const labels = {
+		...DEFAULT_LABELS,
+		...options.labels,
+		callouts: {
+			...DEFAULT_LABELS.callouts,
+			...options.labels?.callouts
+		}
+	};
+	const math = options.math ?? true;
+	const extensions = [
+		flowdownDialect,
+		...math ? [mathSyntax] : [],
+		...options.extensions ?? []
+	];
+	const code = createCodeDrawer(options.highlight ?? null);
+	const doc = createDocument();
+	let columns = options.width ?? DEFAULT_WIDTH;
+	let drawn = /* @__PURE__ */ new WeakMap();
+	return { render(text, { streaming = false, width } = {}) {
+		if (width !== void 0 && width !== columns) {
+			columns = width;
+			drawn = /* @__PURE__ */ new WeakMap();
+		}
+		const state = doc.update(text, {
+			streaming,
+			math
+		});
+		const last = state.blocks.length - 1;
+		const out = [];
+		state.blocks.forEach((block, index) => {
+			const closer = index === last ? state.closer : "";
+			const growing = streaming && index === last;
+			let made = drawn.get(block);
+			if (made === void 0 || made.closer !== closer || made.pieced && !growing) {
+				made = {
+					closer,
+					rows: drawBlock(parse(block.source + closer, { extensions }), columns, labels, code, growing),
+					pieced: code.pieced()
+				};
+				drawn.set(block, made);
+			}
+			if (made.rows.length === 0) return;
+			if (out.length > 0) out.push([]);
+			for (const row of made.rows) out.push(row);
+		});
+		code.turn();
+		return out;
+	} };
+}
+/** `markdown` as terminal rows. */
+function renderToLines(markdown, options = {}) {
+	return createTerminalView(options).render(markdown, { streaming: options.streaming ?? false });
+}
+/**
+* `markdown` as text for a terminal, rows parted by `\n`. `color: false` leaves the escape
+* sequences out: for a pipe, a file, a terminal that asked for none (`NO_COLOR`).
+*/
+function renderToAnsi(markdown, options = {}) {
+	return toAnsi(renderToLines(markdown, options), options.color ?? true);
+}
+export { DEFAULT_LABELS, MIN_WIDTH, createTerminalView, lineText, lineWidth, printable, renderToAnsi, renderToLines, sgr, width as textWidth, toAnsi };
+
+//# sourceMappingURL=index.js.map

package/dist/tui/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../../src/tui/index.ts"],"sourcesContent":["/**\n * `@localix-ai/flowdown/tui`: Markdown as the rows of a terminal.\n *\n *     import { renderToAnsi } from '@localix-ai/flowdown/tui'\n *\n *     process.stdout.write(renderToAnsi(reply, { width: process.stdout.columns }) + '\\n')\n *\n * The same text every other target reads, parsed by the same parser with the same dialect, and\n * drawn in a terminal's terms: words wrapped to the width by the columns they take, tables in\n * columns, a callout behind a coloured bar, steps down a numbered rail. No row is wider than the\n * width, and nothing a reply holds reaches the terminal as an instruction to it (`printable.ts`).\n *\n * A reply still arriving is drawn with a view, which keeps what it drew: each token costs the\n * block it lands in, and the rows of every block before it are the very same objects.\n *\n *     const view = createTerminalView({ width: 80 })\n *     for await (const text of reply) draw(view.render(text, { streaming: true }))\n *     draw(view.render(text))\n *\n * The rows are plain values (`Line`, a list of `{ text, style }`): `toAnsi` writes them for a\n * terminal, and a TUI library with a screen of its own reads them as they are.\n */\nimport { mathSyntax } from '../core/math-syntax'\nimport { flowdownDialect } from '../core/remark-answer-blocks'\nimport { createDocument, type MarkdownBlock } from '../document'\nimport { parse } from '../engine'\nimport type { Extension } from '../engine/types'\nimport { createCodeDrawer, type Highlighter } from './code'\nimport { DEFAULT_LABELS, drawBlock, type TerminalLabels } from './render'\nimport { toAnsi, type Line } from './style'\n\nexport { toAnsi, lineText, sgr, type Colour, type Line, type Span, type Style } from './style'\nexport type { Highlighter } from './code'\nexport { printable } from './printable'\nexport { width as textWidth } from './width'\nexport { lineWidth } from './wrap'\nexport { DEFAULT_LABELS, MIN_WIDTH, type TerminalLabels } from './render'\nexport type { Extension, Node } from '../engine/types'\n\n/** The words the renderer adds, any of them replaced. */\nexport type TerminalLabelOverrides = Partial<Omit<TerminalLabels, 'callouts'>> & {\n  callouts?: Partial<TerminalLabels['callouts']>\n}\n\nexport interface TerminalOptions {\n  /** The columns of the terminal; 80 when not given, and never under 8. */\n  width?: number\n  /** Your own syntax, after the dialect's (`Extension`). A node the renderer does not know is drawn as its text. */\n  extensions?: Extension[]\n  /** The words the renderer adds (callout names), for a terminal in another language. */\n  labels?: TerminalLabelOverrides\n  /**\n   * Colour fenced code: `@localix-ai/flowdown/highlight`, or any function that returns highlight.js's\n   * HTML. Off by default; a language it does not know is drawn in the one colour of code.\n   */\n  highlight?: Highlighter | null\n  /**\n   * Read `$…$`, `$$…$$` and a `math` fence as formulas and write them in Unicode: `x^2` as `x²`,\n   * `\\frac{a}{b}` as `a/b`. On by default; `false` leaves them as the text they were written as.\n   */\n  math?: boolean\n}\n\nexport interface RenderOptions {\n  /** The text is a reply still arriving: its unfinished end is completed. */\n  streaming?: boolean\n  /** The terminal was resized: draw for this width from now on. */\n  width?: number\n}\n\nexport interface TerminalView {\n  /**\n   * The rows for `text`. The rows of a block that did not change are the same objects as at the\n   * last render: a screen that compares by identity repaints only what is new.\n   */\n  render(text: string, options?: RenderOptions): Line[]\n}\n\nconst DEFAULT_WIDTH = 80\n\n/** One text drawn more than once: a reply while it streams. */\nexport function createTerminalView(options: TerminalOptions = {}): TerminalView {\n  const labels: TerminalLabels = {\n    ...DEFAULT_LABELS,\n    ...options.labels,\n    callouts: { ...DEFAULT_LABELS.callouts, ...options.labels?.callouts },\n  }\n  const math = options.math ?? true\n  const extensions = [flowdownDialect, ...(math ? [mathSyntax] : []), ...(options.extensions ?? [])]\n  const code = createCodeDrawer(options.highlight ?? null)\n  const doc = createDocument()\n  let columns = options.width ?? DEFAULT_WIDTH\n  let drawn = new WeakMap<MarkdownBlock, { closer: string; rows: Line[]; pieced: boolean }>()\n  return {\n    render(text, { streaming = false, width } = {}) {\n      if (width !== undefined && width !== columns) {\n        columns = width\n        drawn = new WeakMap()\n      }\n      const state = doc.update(text, { streaming, math })\n      const last = state.blocks.length - 1\n      const out: Line[] = []\n      state.blocks.forEach((block, index) => {\n        const closer = index === last ? state.closer : ''\n        // The end of a reply still arriving: its last fence may gain code with the next token.\n        const growing = streaming && index === last\n        let made = drawn.get(block)\n        // A fence drawn in pieces is drawn whole once nothing more can come to it.\n        if (made === undefined || made.closer !== closer || (made.pieced && !growing)) {\n          const rows = drawBlock(\n            parse(block.source + closer, { extensions }),\n            columns,\n            labels,\n            code,\n            growing,\n          )\n          made = { closer, rows, pieced: code.pieced() }\n          drawn.set(block, made)\n        }\n        if (made.rows.length === 0) return\n        // A blank row between blocks, as between the blocks of one.\n        if (out.length > 0) out.push([])\n        for (const row of made.rows) out.push(row)\n      })\n      code.turn()\n      return out\n    },\n  }\n}\n\n/** `markdown` as terminal rows. */\nexport function renderToLines(\n  markdown: string,\n  options: TerminalOptions & RenderOptions = {},\n): Line[] {\n  return createTerminalView(options).render(markdown, { streaming: options.streaming ?? false })\n}\n\n/**\n * `markdown` as text for a terminal, rows parted by `\\n`. `color: false` leaves the escape\n * sequences out: for a pipe, a file, a terminal that asked for none (`NO_COLOR`).\n */\nexport function renderToAnsi(\n  markdown: string,\n  options: TerminalOptions & RenderOptions & { color?: boolean } = {},\n): string {\n  return toAnsi(renderToLines(markdown, options), options.color ?? true)\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8EA,MAAM,gBAAgB;;AAGtB,SAAgB,mBAAmB,UAA2B,CAAC,GAAiB;CAC9E,MAAM,SAAyB;EAC7B,GAAG;EACH,GAAG,QAAQ;EACX,UAAU;GAAE,GAAG,eAAe;GAAU,GAAG,QAAQ,QAAQ;EAAS;CACtE;CACA,MAAM,OAAO,QAAQ,QAAQ;CAC7B,MAAM,aAAa;EAAC;EAAiB,GAAI,OAAO,CAAC,UAAU,IAAI,CAAC;EAAI,GAAI,QAAQ,cAAc,CAAC;CAAE;CACjG,MAAM,OAAO,iBAAiB,QAAQ,aAAa,IAAI;CACvD,MAAM,MAAM,eAAe;CAC3B,IAAI,UAAU,QAAQ,SAAS;CAC/B,IAAI,wBAAQ,IAAI,QAA0E;CAC1F,OAAO,EACL,OAAO,MAAM,EAAE,YAAY,OAAO,UAAU,CAAC,GAAG;EAC9C,IAAI,UAAU,KAAA,KAAa,UAAU,SAAS;GAC5C,UAAU;GACV,wBAAQ,IAAI,QAAQ;EACtB;EACA,MAAM,QAAQ,IAAI,OAAO,MAAM;GAAE;GAAW;EAAK,CAAC;EAClD,MAAM,OAAO,MAAM,OAAO,SAAS;EACnC,MAAM,MAAc,CAAC;EACrB,MAAM,OAAO,SAAS,OAAO,UAAU;GACrC,MAAM,SAAS,UAAU,OAAO,MAAM,SAAS;GAE/C,MAAM,UAAU,aAAa,UAAU;GACvC,IAAI,OAAO,MAAM,IAAI,KAAK;GAE1B,IAAI,SAAS,KAAA,KAAa,KAAK,WAAW,UAAW,KAAK,UAAU,CAAC,SAAU;IAQ7E,OAAO;KAAE;KAAQ,MAPJ,UACX,MAAM,MAAM,SAAS,QAAQ,EAAE,WAAW,CAAC,GAC3C,SACA,QACA,MACA,OAEkB;KAAG,QAAQ,KAAK,OAAO;IAAE;IAC7C,MAAM,IAAI,OAAO,IAAI;GACvB;GACA,IAAI,KAAK,KAAK,WAAW,GAAG;GAE5B,IAAI,IAAI,SAAS,GAAG,IAAI,KAAK,CAAC,CAAC;GAC/B,KAAK,MAAM,OAAO,KAAK,MAAM,IAAI,KAAK,GAAG;EAC3C,CAAC;EACD,KAAK,KAAK;EACV,OAAO;CACT,EACF;AACF;;AAGA,SAAgB,cACd,UACA,UAA2C,CAAC,GACpC;CACR,OAAO,mBAAmB,OAAO,CAAC,CAAC,OAAO,UAAU,EAAE,WAAW,QAAQ,aAAa,MAAM,CAAC;AAC/F;;;;;AAMA,SAAgB,aACd,UACA,UAAiE,CAAC,GAC1D;CACR,OAAO,OAAO,cAAc,UAAU,OAAO,GAAG,QAAQ,SAAS,IAAI;AACvE"}