@defold-typescript/types 0.37.0 → 0.39.0

package/src/doc-comment.ts

@@ -16,6 +16,47 @@ function decodeEntities(text: string): string {
   return out.split("&").join("&");
 }
 
+/**
+ * Join a list marker left alone on its line back onto the item's first content
+ * line. Upstream prose puts a newline between `<li>` and the item's first word,
+ * which the whitespace pass preserves, dropping the value out of the list. The
+ * item's remaining lines stay where they are: Markdown's lazy continuation
+ * already keeps an unindented line inside the item's paragraph.
+ */
+function weldStrandedListMarkers(text: string): string {
+  const lines = text.split("\n");
+  const out: string[] = [];
+  let inFence = false;
+  for (let index = 0; index < lines.length; index += 1) {
+    const line = lines[index] ?? "";
+    if (line.startsWith("```")) {
+      inFence = !inFence;
+      out.push(line);
+      continue;
+    }
+    if (inFence || line !== "-") {
+      out.push(line);
+      continue;
+    }
+    let ahead = index + 1;
+    while (ahead < lines.length && lines[ahead] === "") ahead += 1;
+    const content = lines[ahead];
+    if (
+      content === undefined ||
+      content === "-" ||
+      content.startsWith("- ") ||
+      content.startsWith("```")
+    ) {
+      // No value to weld onto — drop the marker and the blank run behind it.
+      index = ahead - 1;
+      continue;
+    }
+    out.push(`- ${content}`);
+    index = ahead;
+  }
+  return out.join("\n").trim();
+}
+
 /**
  * Convert a ref-doc HTML fragment to clean Markdown/plain text suitable for a
  * JSDoc comment body. Pure and free of any `ApiModule` dependency so the emit
@@ -45,6 +86,12 @@ export function htmlToDocText(html: string): string {
     .replace(/\n{3,}/g, "\n\n")
     .trim();
 
+  text = weldStrandedListMarkers(text);
+
+  // Upstream prose can open a fence and end mid-body; left open it swallows the
+  // rest of the JSDoc block and everything after it on the rendered page.
+  if ((text.match(/^```/gm) ?? []).length % 2 === 1) text += "\n```";
+
   // A literal `*/` would close the JSDoc comment early; escape it.
   return text.split("*/").join("*\\/");
 }
@@ -70,45 +117,169 @@ export function htmlToCodeText(html: string): string {
   return collapsed.split("*/").join("*\\/");
 }
 
-/**
- * Convert a ref-doc `examples` HTML fragment — prose interleaved with one or
- * more `<div class="codehilite">…</div>` syntax-highlight blocks — into Markdown:
- * prose runs become `htmlToDocText`, each highlight block becomes a fence via
- * `htmlToCodeText`. The fence language comes from a `class="language-X"` on the
- * block's `<code>` (as converted extension `.script_api` examples carry), else
- * `lua`, since engine ref-doc blocks carry no language class. A fragment with no
- * `codehilite` block is wrapped whole as a single ` ```lua ` fence (back-compat
- * for plain-code examples). Returns `""` for empty / whitespace-only input.
- */
-export function examplesHtmlToMarkdown(html: string): string {
-  if (html.trim() === "") return "";
+// One run of the `examples` fragment: the inner markup of a `<div
+// class="codehilite">` block, or the markup between two of them. `lang` is
+// meaningful on a code region only.
+interface ExampleRegion {
+  kind: "code" | "prose";
+  html: string;
+  lang: string;
+}
 
-  const parts: string[] = [];
+// The one `codehilite` walk. Both the markdown lane (`examplesHtmlToMarkdown`)
+// and the store lane (`splitExampleSources`) read their regions from here, so
+// the two cannot disagree about where an example begins. `matched` is false for
+// a fragment carrying no block at all, which both lanes treat as one whole-blob
+// code run.
+function scanExampleRegions(html: string): { matched: boolean; regions: ExampleRegion[] } {
+  const regions: ExampleRegion[] = [];
   const blocks = /<div class="codehilite">([\s\S]*?)<\/div>/gi;
   let lastIndex = 0;
   let matched = false;
   for (let match = blocks.exec(html); match !== null; match = blocks.exec(html)) {
     matched = true;
-    const prose = htmlToDocText(html.slice(lastIndex, match.index));
-    if (prose !== "") parts.push(prose);
+    regions.push({ kind: "prose", html: html.slice(lastIndex, match.index), lang: "lua" });
     const inner = match[1] ?? "";
-    const lang = /<code\b[^>]*\bclass="language-([^"\s]+)"/i.exec(inner)?.[1] ?? "lua";
-    const code = htmlToCodeText(inner);
-    if (code !== "") parts.push(`\`\`\`${lang}\n${code}\n\`\`\``);
+    regions.push({
+      kind: "code",
+      html: inner,
+      lang: /<code\b[^>]*\bclass="language-([^"\s]+)"/i.exec(inner)?.[1] ?? "lua",
+    });
     lastIndex = match.index + match[0].length;
   }
+  if (!matched) return { matched: false, regions: [{ kind: "code", html, lang: "lua" }] };
+  regions.push({ kind: "prose", html: html.slice(lastIndex), lang: "lua" });
+  return { matched: true, regions };
+}
 
-  if (!matched) {
-    const code = htmlToCodeText(html);
-    return code === "" ? "" : `\`\`\`lua\n${code}\n\`\`\``;
-  }
+/**
+ * Convert a ref-doc `examples` HTML fragment — prose interleaved with one or
+ * more `<div class="codehilite">…</div>` syntax-highlight blocks — into Markdown,
+ * one fence per example that `segmentExampleRegions` carves out. Each segment
+ * emits its leading prose then a fence in its own language: `class="language-X"`
+ * on the block's `<code>` (as converted extension `.script_api` examples carry)
+ * or an inner ` ```X ` opener, else `lua`, since engine ref-doc blocks carry no
+ * language class. Prose trailing the last example is emitted last, and a
+ * fragment with no `codehilite` block is wrapped whole as a single ` ```lua `
+ * fence (back-compat for plain-code examples). Returns `""` for empty /
+ * whitespace-only input.
+ */
+export function examplesHtmlToMarkdown(html: string): string {
+  const { segments, trailingProse } = segmentExampleRegions(html);
 
-  const trailing = htmlToDocText(html.slice(lastIndex));
-  if (trailing !== "") parts.push(trailing);
+  const parts: string[] = [];
+  for (const segment of segments) {
+    if (segment.prose !== "") parts.push(segment.prose);
+    parts.push(`\`\`\`${segment.lang}\n${segment.code}\n\`\`\``);
+  }
+  if (trailingProse !== "") parts.push(trailingProse);
 
   return parts.join("\n\n");
 }
 
+/** One example carved out of an `examples` fragment, with the prose leading it. */
+export interface ExampleSegment {
+  prose: string;
+  code: string;
+  lang: string;
+}
+
+// A line that opens a code run: ``` followed by a bare language token and
+// nothing else. Any other ``` line closes the run, its remainder being prose
+// upstream welded onto the fence.
+const FENCE_OPENER = /^```([A-Za-z0-9_+-]+)$/;
+
+/** The examples a fragment carries, plus any prose left over after the last one. */
+export interface ExampleSegmentation {
+  segments: ExampleSegment[];
+  /** Prose following the final code run, which belongs to no segment. */
+  trailingProse: string;
+}
+
+/**
+ * Carve an `examples` HTML fragment into one segment per example it carries.
+ *
+ * A `<div class="codehilite">` block is a code region and the markup between
+ * two of them is a prose region; inside either, a ` ``` ` line switches between
+ * code and prose, and an opener reached while already in code ends the running
+ * example and starts the next. Upstream writes several examples both ways — as
+ * several blocks, and as its own Markdown fences inside one block — so both
+ * signals are read.
+ *
+ * This is the walk alone: no whole-blob fallback, so a caller sees the real
+ * segments even where there is only one. `splitExampleSources` adds the
+ * stability post-pass that keys stored translations.
+ */
+export function segmentExampleRegions(html: string): ExampleSegmentation {
+  if (html.trim() === "") return { segments: [], trailingProse: "" };
+
+  const { regions } = scanExampleRegions(html);
+  const segments: ExampleSegment[] = [];
+  let codeLines: string[] = [];
+  let proseLines: string[] = [];
+  let lang = "lua";
+
+  const flush = () => {
+    const code = trimBlankEdges(codeLines).join("\n");
+    codeLines = [];
+    if (code === "") return;
+    segments.push({ prose: trimBlankEdges(proseLines).join("\n"), code, lang });
+    proseLines = [];
+  };
+
+  for (const region of regions) {
+    const text = region.kind === "code" ? htmlToCodeText(region.html) : htmlToDocText(region.html);
+    let inCode = region.kind === "code";
+    if (region.kind === "code") lang = region.lang;
+    // Prose surviving an empty code run keeps its paragraph break from the next.
+    if (region.kind === "prose" && text !== "" && proseLines.length > 0) proseLines.push("");
+    for (const line of text === "" ? [] : text.split("\n")) {
+      const trimmed = line.trim();
+      if (!trimmed.startsWith("```")) {
+        (inCode ? codeLines : proseLines).push(line);
+        continue;
+      }
+      const opener = FENCE_OPENER.exec(trimmed);
+      if (opener) {
+        if (inCode) flush();
+        inCode = true;
+        lang = opener[1] ?? lang;
+        continue;
+      }
+      flush();
+      inCode = false;
+      const remainder = trimmed.slice(3).trim();
+      if (remainder !== "") proseLines.push(remainder);
+    }
+    flush();
+  }
+
+  return { segments, trailingProse: trimBlankEdges(proseLines).join("\n") };
+}
+
+/**
+ * `segmentExampleRegions` plus the stability post-pass: a fragment that yields
+ * at most one segment returns the whole-blob `htmlToCodeText` verbatim, prose
+ * lines included. That is the string every stored translation is pinned
+ * against, so a single-example element keeps its identity and cannot be re-keyed
+ * by this walk.
+ */
+export function splitExampleSources(html: string): ExampleSegment[] {
+  const { segments } = segmentExampleRegions(html);
+  if (segments.length > 1) return segments;
+  if (html.trim() === "") return [];
+  const whole = htmlToCodeText(html);
+  if (whole === "") return [];
+  return [{ prose: "", code: whole, lang: segments[0]?.lang ?? "lua" }];
+}
+
+function trimBlankEdges(lines: readonly string[]): string[] {
+  const out = [...lines];
+  while (out.length > 0 && out[0]?.trim() === "") out.shift();
+  while (out.length > 0 && out[out.length - 1]?.trim() === "") out.pop();
+  return out;
+}
+
 export interface DocCommentParts {
   summary: string;
   // Present exactly when the source carried a deprecation tag; `""` is the bare
@@ -117,8 +288,12 @@ export interface DocCommentParts {
   deprecated?: string;
   params?: { name: string; doc: string }[];
   returns?: string;
-  example?: string;
-  exampleLang?: "lua" | "ts";
+  // One entry per example the element documents, each rendered as its own
+  // `@example` block. An element whose ref-doc blob holds several examples
+  // carries several entries; a blank body is dropped. `prose` is the sentence
+  // introducing that example, rendered above its fence; blank or absent leaves
+  // the block byte-identical to a prose-less one.
+  examples?: { text: string; lang: "lua" | "ts"; prose?: string }[];
 }
 
 /**
@@ -129,14 +304,14 @@ export function renderDocComment(parts: DocCommentParts): string[] {
   const summaryLines = parts.summary.trim() === "" ? [] : parts.summary.split("\n");
   const params = (parts.params ?? []).filter((p) => p.doc.trim() !== "");
   const returns = parts.returns?.trim() ? parts.returns : "";
-  const example = parts.example?.trim() ? parts.example : "";
+  const examples = (parts.examples ?? []).filter((entry) => entry.text.trim() !== "");
   const deprecated = parts.deprecated;
 
   if (
     summaryLines.length === 0 &&
     params.length === 0 &&
     returns === "" &&
-    example === "" &&
+    examples.length === 0 &&
     deprecated === undefined
   ) {
     return [];
@@ -147,7 +322,8 @@ export function renderDocComment(parts: DocCommentParts): string[] {
     lines.push(line === "" ? " *" : ` * ${line}`);
   }
 
-  const hasTags = deprecated !== undefined || params.length > 0 || returns !== "" || example !== "";
+  const hasTags =
+    deprecated !== undefined || params.length > 0 || returns !== "" || examples.length > 0;
   if (summaryLines.length > 0 && hasTags) {
     lines.push(" *");
   }
@@ -173,10 +349,15 @@ export function renderDocComment(parts: DocCommentParts): string[] {
       lines.push(line === "" ? " *" : ` * ${line}`);
     }
   }
-  if (example !== "") {
+  for (const entry of examples) {
     lines.push(" * @example");
-    lines.push(` * \`\`\`${parts.exampleLang ?? "lua"}`);
-    for (const line of example.split("\n")) {
+    if (entry.prose !== undefined && entry.prose.trim() !== "") {
+      for (const line of entry.prose.split("\n")) {
+        lines.push(line === "" ? " *" : ` * ${line}`);
+      }
+    }
+    lines.push(` * \`\`\`${entry.lang}`);
+    for (const line of entry.text.split("\n")) {
       lines.push(line === "" ? " *" : ` * ${line}`);
     }
     lines.push(" * ```");