md4x 0.0.17 → 0.0.18

package/lib/cli.mjs

@@ -8,6 +8,7 @@ import {
   renderToText,
   parseAST,
   parseMeta,
+  heal,
 } from "./napi.mjs";
 
 const { values, positionals } = parseArgs({
@@ -22,6 +23,7 @@ const { values, positionals } = parseArgs({
     "full-html": { type: "boolean", short: "f", default: false },
     "html-title": { type: "string" },
     "html-css": { type: "string" },
+    heal: { type: "boolean", default: false },
     stat: { type: "boolean", short: "s", default: false },
     help: { type: "boolean", short: "h", default: false },
     version: { type: "boolean", short: "v", default: false },
@@ -43,7 +45,8 @@ ${_g("Usage:")} ${_b("md4x")} ${_d("[OPTION]... [FILE]")}
 
 ${_g("General options:")}
   ${_c("-o")}, ${_c("--output")}=${_d("FILE")}     Output file ${_d("(default: stdout)")}
-  ${_c("-t")}, ${_c("--format")}=${_d("FORMAT")}   Output format: ${_c("html")}, ${_c("text")}, ${_c("ast")}, ${_c("ansi")}, ${_c("meta")} ${_d("(default: ansi for TTY, text otherwise)")}
+  ${_c("-t")}, ${_c("--format")}=${_d("FORMAT")}   Output format: ${_c("html")}, ${_c("text")}, ${_c("ast")}, ${_c("ansi")}, ${_c("meta")}, ${_c("heal")} ${_d("(default: ansi for TTY, text otherwise)")}
+      ${_c("--heal")}             Heal incomplete markdown before rendering
   ${_c("-s")}, ${_c("--stat")}            Measure parsing time
   ${_c("-h")}, ${_c("--help")}            Display this help and exit
   ${_c("-v")}, ${_c("--version")}         Display version and exit
@@ -89,7 +92,7 @@ if (values.version) {
   process.exit(0);
 }
 
-const supportedFormats = ["html", "ast", "ansi", "text", "meta"];
+const supportedFormats = ["html", "ast", "ansi", "text", "meta", "heal"];
 const format = values.format;
 if (!supportedFormats.includes(format)) {
   process.stderr.write(`Unknown format: ${format}\n`);
@@ -154,22 +157,27 @@ if (!inputPath || inputPath === "-") {
 
 const t0 = values.stat ? performance.now() : 0;
 
+const healOpt = values.heal ? { heal: true } : undefined;
+
 let output;
 switch (format) {
   case "html":
-    output = renderToHtml(input);
+    output = renderToHtml(input, healOpt);
     break;
   case "ansi":
-    output = renderToAnsi(input);
+    output = renderToAnsi(input, healOpt);
     break;
   case "text":
-    output = renderToText(input);
+    output = renderToText(input, healOpt);
     break;
   case "ast":
-    output = JSON.stringify(parseAST(input), null, 2);
+    output = JSON.stringify(parseAST(input, healOpt), null, 2);
     break;
   case "meta":
-    output = JSON.stringify(parseMeta(input), null, 2);
+    output = JSON.stringify(parseMeta(input, healOpt), null, 2);
+    break;
+  case "heal":
+    output = heal(input);
     break;
 }
 

package/lib/napi.d.mts

@@ -1,4 +1,9 @@
-import type { ComarkTree, ComarkMeta, HtmlOptions } from "./types.mjs";
+import type {
+  ComarkTree,
+  ComarkMeta,
+  HtmlOptions,
+  RenderOptions,
+} from "./types.mjs";
 
 export type {
   ComarkTree,
@@ -9,14 +14,16 @@ export type {
   ComarkHeading,
   ComarkMeta,
   HtmlOptions,
+  RenderOptions,
 } from "./types.mjs";
 
 export interface NAPIBinding {
   renderToHtml(input: string, flags?: number): string;
-  renderToAST(input: string): string;
-  renderToAnsi(input: string): string;
-  renderToMeta(input: string): string;
-  renderToText(input: string): string;
+  renderToAST(input: string, flags?: number): string;
+  renderToAnsi(input: string, flags?: number): string;
+  renderToMeta(input: string, flags?: number): string;
+  renderToText(input: string, flags?: number): string;
+  heal(input: string): string;
 }
 
 export interface InitOptions {
@@ -25,9 +32,28 @@ export interface InitOptions {
 
 export declare function init(opts?: InitOptions): Promise<void>;
 export declare function renderToHtml(input: string, opts?: HtmlOptions): string;
-export declare function renderToAST(input: string): string;
-export declare function parseAST(input: string): ComarkTree;
-export declare function renderToAnsi(input: string): string;
-export declare function renderToMeta(input: string): string;
-export declare function parseMeta(input: string): ComarkMeta;
-export declare function renderToText(input: string): string;
+export declare function renderToAST(
+  input: string,
+  opts?: RenderOptions,
+): string;
+export declare function parseAST(
+  input: string,
+  opts?: RenderOptions,
+): ComarkTree;
+export declare function renderToAnsi(
+  input: string,
+  opts?: RenderOptions,
+): string;
+export declare function renderToMeta(
+  input: string,
+  opts?: RenderOptions,
+): string;
+export declare function parseMeta(
+  input: string,
+  opts?: RenderOptions,
+): ComarkMeta;
+export declare function renderToText(
+  input: string,
+  opts?: RenderOptions,
+): string;
+export declare function heal(input: string): string;

package/lib/napi.mjs

@@ -28,35 +28,46 @@ export function init(opts) {
   }
 }
 
+const HEAL_FLAG = 0x0100;
+
 export function renderToHtml(input, opts) {
-  const flags = opts?.full ? 0x0008 : 0;
+  let flags = opts?.full ? 0x0008 : 0;
+  if (opts?.heal) flags |= HEAL_FLAG;
   return getBinding().renderToHtml(input, flags);
 }
 
-export function renderToAST(input) {
-  return getBinding().renderToAST(input);
+export function renderToAST(input, opts) {
+  const flags = opts?.heal ? HEAL_FLAG : 0;
+  return getBinding().renderToAST(input, flags);
 }
 
-export function parseAST(input) {
-  return JSON.parse(renderToAST(input));
+export function parseAST(input, opts) {
+  return JSON.parse(renderToAST(input, opts));
 }
 
-export function renderToAnsi(input) {
-  return getBinding().renderToAnsi(input);
+export function renderToAnsi(input, opts) {
+  const flags = opts?.heal ? HEAL_FLAG : 0;
+  return getBinding().renderToAnsi(input, flags);
 }
 
-export function renderToMeta(input) {
-  return getBinding().renderToMeta(input);
+export function renderToMeta(input, opts) {
+  const flags = opts?.heal ? HEAL_FLAG : 0;
+  return getBinding().renderToMeta(input, flags);
 }
 
-export function renderToText(input) {
-  return getBinding().renderToText(input);
+export function renderToText(input, opts) {
+  const flags = opts?.heal ? HEAL_FLAG : 0;
+  return getBinding().renderToText(input, flags);
 }
 
-export function parseMeta(input) {
-  const meta = JSON.parse(renderToMeta(input));
+export function parseMeta(input, opts) {
+  const meta = JSON.parse(renderToMeta(input, opts));
   if (!meta.title && meta.headings?.[0]) {
     meta.title = meta.headings[0].text;
   }
   return meta;
 }
+
+export function heal(input) {
+  return getBinding().heal(input);
+}

package/lib/types.d.mts

@@ -29,7 +29,12 @@ export type ComarkMeta = {
   [key: string]: unknown;
 };
 
-export interface HtmlOptions {
+export interface RenderOptions {
+  /** Heal incomplete/streaming Markdown before rendering. */
+  heal?: boolean;
+}
+
+export interface HtmlOptions extends RenderOptions {
   /** Generate a full HTML document with `<!DOCTYPE html>`, `<head>`, and `<body>`. */
   full?: boolean;
 }

package/lib/wasm/common.mjs

@@ -48,40 +48,52 @@ function render(exports, fn, input, ...extra) {
   return result;
 }
 
+const HEAL_FLAG = 0x0100;
+
 export function renderToHtml(input, opts) {
-  const flags = opts?.full ? 0x0008 : 0;
+  let flags = opts?.full ? 0x0008 : 0;
+  if (opts?.heal) flags |= HEAL_FLAG;
   const exports = _getExports();
   return render(exports, exports.md4x_to_html, input, flags);
 }
 
-export function renderToAST(input) {
+export function renderToAST(input, opts) {
+  const flags = opts?.heal ? HEAL_FLAG : 0;
   const exports = _getExports();
-  return render(exports, exports.md4x_to_ast, input);
+  return render(exports, exports.md4x_to_ast, input, flags);
 }
 
-export function parseAST(input) {
-  return JSON.parse(renderToAST(input));
+export function parseAST(input, opts) {
+  return JSON.parse(renderToAST(input, opts));
 }
 
-export function renderToAnsi(input) {
+export function renderToAnsi(input, opts) {
+  const flags = opts?.heal ? HEAL_FLAG : 0;
   const exports = _getExports();
-  return render(exports, exports.md4x_to_ansi, input);
+  return render(exports, exports.md4x_to_ansi, input, flags);
 }
 
-export function renderToMeta(input) {
+export function renderToMeta(input, opts) {
+  const flags = opts?.heal ? HEAL_FLAG : 0;
   const exports = _getExports();
-  return render(exports, exports.md4x_to_meta, input);
+  return render(exports, exports.md4x_to_meta, input, flags);
 }
 
-export function renderToText(input) {
+export function renderToText(input, opts) {
+  const flags = opts?.heal ? HEAL_FLAG : 0;
   const exports = _getExports();
-  return render(exports, exports.md4x_to_text, input);
+  return render(exports, exports.md4x_to_text, input, flags);
 }
 
-export function parseMeta(input) {
-  const meta = JSON.parse(renderToMeta(input));
+export function parseMeta(input, opts) {
+  const meta = JSON.parse(renderToMeta(input, opts));
   if (!meta.title && meta.headings?.[0]) {
     meta.title = meta.headings[0].text;
   }
   return meta;
 }
+
+export function heal(input) {
+  const exports = _getExports();
+  return render(exports, exports.md4x_heal, input);
+}

package/lib/wasm/defult.mjs

@@ -6,6 +6,7 @@ export {
   parseMeta,
   renderToMeta,
   renderToText,
+  heal,
 } from "./common.mjs";
 
 import { _setInstance, _imports, _hasInstance } from "./common.mjs";

package/lib/wasm/index.d.mts

@@ -1,4 +1,9 @@
-import type { ComarkTree, ComarkMeta, HtmlOptions } from "../types.mjs";
+import type {
+  ComarkTree,
+  ComarkMeta,
+  HtmlOptions,
+  RenderOptions,
+} from "../types.mjs";
 
 export type {
   ComarkTree,
@@ -9,6 +14,7 @@ export type {
   ComarkHeading,
   ComarkMeta,
   HtmlOptions,
+  RenderOptions,
 } from "../types.mjs";
 
 export interface InitOptions {
@@ -22,9 +28,28 @@ export interface InitOptions {
 
 export declare function init(opts?: InitOptions): Promise<void>;
 export declare function renderToHtml(input: string, opts?: HtmlOptions): string;
-export declare function renderToAST(input: string): string;
-export declare function parseAST(input: string): ComarkTree;
-export declare function renderToAnsi(input: string): string;
-export declare function renderToMeta(input: string): string;
-export declare function parseMeta(input: string): ComarkMeta;
-export declare function renderToText(input: string): string;
+export declare function renderToAST(
+  input: string,
+  opts?: RenderOptions,
+): string;
+export declare function parseAST(
+  input: string,
+  opts?: RenderOptions,
+): ComarkTree;
+export declare function renderToAnsi(
+  input: string,
+  opts?: RenderOptions,
+): string;
+export declare function renderToMeta(
+  input: string,
+  opts?: RenderOptions,
+): string;
+export declare function parseMeta(
+  input: string,
+  opts?: RenderOptions,
+): ComarkMeta;
+export declare function renderToText(
+  input: string,
+  opts?: RenderOptions,
+): string;
+export declare function heal(input: string): string;

package/lib/wasm/unwasm.mjs

@@ -6,6 +6,7 @@ export {
   parseMeta,
   renderToMeta,
   renderToText,
+  heal,
 } from "./common.mjs";
 
 import { _setInstance, _hasInstance, _imports } from "./common.mjs";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "md4x",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "repository": "pi0/md4x",
   "license": "MIT",
   "type": "module",