Upgrade to TypeScript v5.2

packages/docs-data/compile-docs-data.mjs

@@ -14,7 +14,7 @@ import semver from "semver";
 
 import { Classes } from "@blueprintjs/core";
 
-import { markedRenderer } from "./markdownRenderer.mjs";
+import { hooks, markedRenderer } from "./markdownRenderer.mjs";
 
 /** Run Documentalist on Sass, TypeScript, and package.json files in these packages */
 const LIBRARY_PACKAGES = ["core", "datetime", "datetime2", "icons", "select", "table"];
@@ -52,7 +52,10 @@ console.info(`[docs-data] successfully generated docs.json`);
  */
 async function generateDocumentalistData() {
     const documentalist = new Documentalist({
-        markdown: { renderer: markedRenderer },
+        markdown: {
+            renderer: markedRenderer,
+            hooks,
+        },
         sourceBaseDir: monorepoRootDir,
         // must mark our @Decorator APIs as reserved so we can use them in code samples
         reservedTags: ["import", "ContextMenuTarget", "HotkeysTarget", "param", "returns"],

packages/docs-data/markdownRenderer.mjs

@@ -47,4 +47,13 @@ function renderMarkdown(textContent) {
     return marked(textContent, { renderer });
 }
 
-export { renderMarkdown, renderer as markedRenderer };
+const hooks = {
+    // HACKHACK: workaround for https://github.com/palantir/documentalist/issues/248
+    // We are getting inline code snippets wrapped by newlines, which breaks the markdown rendering of multiline JSDoc
+    // comments. We can work around this by removing the newlines. This should work for all practical cases since we
+    // don't expect any JSDoc comment line to simply have a `code` token as its only contents.
+    preprocess: md => md.replace(/\n(\`.*\`)\n/g, "$1"),
+    postprocess: html => html,
+};
+
+export { hooks, renderMarkdown, renderer as markedRenderer };