@abreen/tada 1.4.0 → 1.5.0

package/build/utils/render.ts

@@ -12,8 +12,11 @@ import {
   extractJavaMethodToc,
   renderCodeSegment,
   renderCodeWithComments,
+  rewriteProseLinks,
 } from './code';
 import { extensionIsMarkdown } from './file-types';
+import { createTraceHelpers } from './trace';
+import { createIncludeFunction } from './include';
 import { createApplyBasePath, normalizeOutputPath } from './paths';
 import { parseFrontMatterAndContent } from './front-matter';
 import { createMarkdown } from './markdown';
@@ -34,7 +37,7 @@ import type {
   RenderCopiedContentOptions,
 } from '../types';
 
-const log = makeLogger(__filename);
+const log = makeLogger(import.meta.url);
 
 const REQUIRED_FRONT_MATTER_FIELDS = ['title'];
 
@@ -95,7 +98,7 @@ function createTemplateParameters({
   subPath,
 }: TemplateParametersInput): Record<string, unknown> {
   return {
-    ...(siteVariables.vars || {}),
+    vars: siteVariables.vars || {},
     ...createGlobals(pageVariables, siteVariables, subPath),
     site: siteVariables,
     base: siteVariables.base,
@@ -132,8 +135,22 @@ export function injectAssetTags(
     )
     .join('');
 
+  const fontPreloadTags = [
+    'inter/InterVariable.woff2',
+    'google-sans-code/GoogleSansCodeVariable.woff2',
+  ]
+    .filter(f => fs.existsSync(path.join(distDir, f)))
+    .map(
+      f =>
+        `<link rel="preload" href="${applyBasePath('/' + f)}" as="font" type="font/woff2" crossorigin>`,
+    )
+    .join('');
+
   return html
-    .replace('<head>', `<head>${criticalTags}${asyncLinkTags}`)
+    .replace(
+      '<head>',
+      `<head>${fontPreloadTags}${criticalTags}${asyncLinkTags}`,
+    )
     .replace('</head>', `${scriptTags}</head>`);
 }
 
@@ -160,19 +177,27 @@ export function renderPlainTextPageAsset({
   siteVariables,
   validInternalTargets,
   assetFiles,
+  literateJavaOutputPaths,
+  traceCache,
 }: RenderPlainTextOptions): Asset[] {
   const { dir, name, ext } = path.parse(filePath);
   const subPath = path.relative(contentDir, path.join(dir, name));
   const applyBasePath = createApplyBasePath(siteVariables);
 
   log.info`Rendering page ${B`${subPath + ext}`}`;
-  const { content, pageVariables, tocItems } = renderPlainTextContent(
+  const { content, pageVariables, tocItems, alertIds } = renderPlainTextContent(
     filePath,
     subPath,
     siteVariables,
     applyBasePath,
     validInternalTargets,
-    { validateInternalLinks: extensionIsMarkdown(ext.toLowerCase()) },
+    {
+      validateInternalLinks: extensionIsMarkdown(ext.toLowerCase()),
+      traceCache,
+      contentDir,
+      distDir,
+      literateJavaOutputPaths,
+    },
   );
 
   validateFrontMatter(pageVariables, filePath);
@@ -184,6 +209,7 @@ export function renderPlainTextPageAsset({
   if (pageVariables.toc && tocItems) {
     pageVariables.tocHtml = generateTocHtml(
       tocItems as Parameters<typeof generateTocHtml>[0],
+      alertIds,
     );
   }
 
@@ -224,9 +250,15 @@ export function renderCodePageAsset({
   const applyBasePath = createApplyBasePath(siteVariables);
   const lang = siteVariables.codeLanguages![ext.slice(1).toLowerCase()];
   const sourceCode = fs.readFileSync(filePath, 'utf-8');
+  const pageDirPath = path.relative(contentDir, dir);
 
   log.info`Rendering code page ${B`${subPath + ext}`}`;
-  const content = renderCodeWithComments(sourceCode, lang, siteVariables);
+  const content = renderCodeWithComments(
+    sourceCode,
+    lang,
+    siteVariables,
+    pageDirPath,
+  );
   const codeFilePath = applyBasePath(
     normalizeOutputPath(`/${toContentAssetPath(contentDir, filePath)}`),
   );
@@ -261,7 +293,10 @@ export function renderCodePageAsset({
 
   return [
     {
-      assetPath: toContentAssetPath(contentDir, path.join(dir, `${name}.html`)),
+      assetPath: toContentAssetPath(
+        contentDir,
+        path.join(dir, `${name}${ext}.html`),
+      ),
       content: html,
     },
   ];
@@ -270,11 +305,24 @@ export function renderCodePageAsset({
 export function renderCopiedContentAsset({
   filePath,
   contentDir,
+  siteVariables,
 }: RenderCopiedContentOptions): Asset[] {
   const label = 'Copying source file';
   const relPath = toContentAssetPath(contentDir, filePath);
 
   log.info`${label} ${B`${relPath}`}`;
+
+  if (filePath.endsWith('.java') && isFeatureEnabled(siteVariables, 'code')) {
+    const sourceCode = fs.readFileSync(filePath, 'utf-8');
+    const pageDirPath = path.relative(contentDir, path.dirname(filePath));
+    const rewrittenLines = rewriteProseLinks(
+      sourceCode.split('\n'),
+      siteVariables,
+      pageDirPath,
+    );
+    return [{ assetPath: relPath, content: rewrittenLines.join('\n') }];
+  }
+
   return [{ assetPath: relPath, content: fs.readFileSync(filePath) }];
 }
 
@@ -285,11 +333,32 @@ function renderPlainTextContent(
   siteVariables: SiteVariables,
   applyBasePath: (subPath: string) => string,
   validInternalTargets: Set<string>,
-  { validateInternalLinks = true } = {},
+  {
+    validateInternalLinks = true,
+    traceCache,
+    contentDir,
+    distDir,
+    literateJavaOutputPaths,
+  }: {
+    validateInternalLinks?: boolean;
+    traceCache?: Map<
+      string,
+      {
+        manifestUrl: string;
+        highlightedSource: string;
+        totalSteps: number;
+        mtime: number;
+      }
+    >;
+    contentDir?: string;
+    distDir?: string;
+    literateJavaOutputPaths?: Set<string>;
+  } = {},
 ): {
   content: string | null;
   pageVariables: Record<string, unknown>;
   tocItems: unknown[] | null;
+  alertIds: string[];
 } {
   const sourceUrlPath = `/${subPath}.html`;
   const md = createMarkdown(siteVariables, {
@@ -302,6 +371,8 @@ function renderPlainTextContent(
         ? Object.keys(siteVariables.codeLanguages!)
         : [],
     },
+    literateJavaOutputPaths,
+    sourceUrlPath,
   });
 
   const ext = path.extname(filePath);
@@ -368,6 +439,19 @@ function renderPlainTextContent(
     subPath,
   });
 
+  if (traceCache && contentDir && distDir) {
+    const helpers = createTraceHelpers({
+      filePath,
+      contentDir,
+      distDir,
+      applyBasePath,
+      cache: traceCache,
+    });
+    params.renderTrace = helpers.renderTrace;
+  }
+
+  params.include = createIncludeFunction(filePath, params);
+
   let html: string;
   try {
     html = _.template(strippedContent)(params);
@@ -379,16 +463,19 @@ function renderPlainTextContent(
   }
 
   let tocItems: unknown[] | null = null;
+  let alertIds: string[] = [];
   if (extensionIsMarkdown(ext)) {
-    const env: Record<string, unknown> = {};
+    const env: Record<string, unknown> = { alertIds: [] as string[] };
     html = md.render(html!, env);
     tocItems = (env.tocItems as unknown[] | undefined) || null;
+    alertIds = env.alertIds as string[];
   }
 
   return {
     content: html,
     pageVariables: params.page as Record<string, unknown>,
     tocItems,
+    alertIds,
   };
 }
 
@@ -403,6 +490,8 @@ export function renderLiterateJavaPageAsset({
   siteVariables,
   assetFiles,
   skipExecution,
+  validInternalTargets,
+  literateJavaOutputPaths,
 }: RenderLiterateJavaOptions): Asset[] {
   const { dir, name } = path.parse(filePath);
   const className = deriveClassName(filePath);
@@ -453,8 +542,18 @@ export function renderLiterateJavaPageAsset({
 
   // Render full markdown with a custom fence rule that replaces fences
   // with Shiki-highlighted code blocks and optional JDI output columns
+  const sourceUrlPath = `/${subPath}.java.html`;
   const md = createMarkdown(siteVariables, {
-    validatorOptions: { enabled: false },
+    validatorOptions: {
+      filePath,
+      sourceUrlPath,
+      validTargets: validInternalTargets,
+      codeExtensions: isFeatureEnabled(siteVariables, 'code')
+        ? Object.keys(siteVariables.codeLanguages!)
+        : [],
+    },
+    literateJavaOutputPaths,
+    sourceUrlPath,
   });
   let fenceIndex = 0;
   const defaultFence = md.renderer.rules.fence!;
@@ -506,7 +605,7 @@ export function renderLiterateJavaPageAsset({
     return codeHtml;
   };
 
-  const env: Record<string, unknown> = {};
+  const env: Record<string, unknown> = { alertIds: [] as string[] };
   const contentHtml = md.render(stripHtmlComments(content), env);
 
   // Build page variables
@@ -527,6 +626,7 @@ export function renderLiterateJavaPageAsset({
   if (pageVariables.toc && env.tocItems) {
     pageVariables.tocHtml = generateTocHtml(
       env.tocItems as Parameters<typeof generateTocHtml>[0],
+      env.alertIds as string[],
     );
   }
 
@@ -550,7 +650,7 @@ export function renderLiterateJavaPageAsset({
     {
       assetPath: toContentAssetPath(
         contentDir,
-        path.join(dir, `${className}.html`),
+        path.join(dir, `${className}.java.html`),
       ),
       content: html,
     },

package/build/utils/shiki-highlighter.ts

@@ -1,7 +1,7 @@
 import type { HighlighterGeneric, BundledLanguage, BundledTheme } from 'shiki';
 import { makeLogger } from '../log';
 
-const log = makeLogger(__filename);
+const log = makeLogger(import.meta.url);
 
 let highlighter: HighlighterGeneric<BundledLanguage, BundledTheme> | null =
   null;