@abreen/tada 1.13.7 → 1.13.9

package/build/generate-content-assets.ts

@@ -6,16 +6,14 @@ import { createContentRecord } from './source-records';
 import { validateConfigLinks } from './validate-config-links';
 import { config, getConfigFileName } from './templates';
 import { initHighlighter } from './utils/shiki-highlighter';
-import { checkTraceToolAvailability, isTraceSourceFile } from './utils/trace';
+import { checkTraceToolAvailability } from './utils/trace';
 import type {
   SiteVariables,
   ContentRenderOptions,
   ContentRenderResult,
   HtmlOutputAnalysis,
   TraceToolAvailability,
-  WatchState,
 } from './types';
-import type { TadaSourceRecord } from './watch/snapshot';
 
 const log = makeLogger(import.meta.url);
 
@@ -25,11 +23,19 @@ function cloneHtmlOutputAnalysis(
   return { outgoingTargets: new Set(analysis.outgoingTargets) };
 }
 
+function writeRecordOutputs(
+  distDir: string,
+  outputs: Map<string, string | Buffer>,
+): void {
+  for (const [outputPath, content] of outputs) {
+    const outPath = path.join(distDir, outputPath);
+    fs.mkdirSync(path.dirname(outPath), { recursive: true });
+    fs.writeFileSync(outPath, content);
+  }
+}
+
 export class ContentRenderer {
   private siteVariables: SiteVariables;
-  private sourceFileCache: Map<string, TadaSourceRecord>;
-  private lastBuildFiles: Set<string>;
-  private javacAvailable: boolean | undefined;
   private traceToolAvailability: TraceToolAvailability | undefined;
   private traceCache: Map<
     string,
@@ -44,133 +50,23 @@ export class ContentRenderer {
 
   constructor(siteVariables: SiteVariables) {
     this.siteVariables = siteVariables;
-    this.sourceFileCache = new Map();
-    this.lastBuildFiles = new Set();
-  }
-
-  private getCachedRecord(filePath: string): TadaSourceRecord | undefined {
-    return this.sourceFileCache.get(filePath);
   }
 
   async initHighlighter(): Promise<void> {
     await initHighlighter(getRuntimeBundledShikiLanguages(this.siteVariables));
   }
 
-  getDirtySourceFiles(
-    buildContentFiles: string[],
-    { changedContentFiles, jsonDataChanged, partialsChanged }: WatchState = {},
-  ): Set<string> {
-    if (
-      this.lastBuildFiles.size === 0 ||
-      !changedContentFiles ||
-      jsonDataChanged ||
-      partialsChanged
-    ) {
-      return new Set(buildContentFiles);
-    }
-
-    // If any trace source changed, the trace cache will be stale, so rebuild
-    // all content pages to pick up the new trace output.
-    const traceFileChanged = [...changedContentFiles].some(isTraceSourceFile);
-    if (traceFileChanged) {
-      return new Set(buildContentFiles);
-    }
-
-    const buildFileSet = new Set(buildContentFiles);
-    const dirtySourceFiles = new Set<string>();
-    for (const filePath of changedContentFiles) {
-      if (buildFileSet.has(filePath)) {
-        dirtySourceFiles.add(filePath);
-      }
-    }
-    return dirtySourceFiles;
-  }
-
-  updateSourceCache(
-    filePath: string,
-    record: TadaSourceRecord,
-    changedOutputRelPaths: Set<string>,
-    removedOutputRelPaths: Set<string>,
-    changedHtmlAssetPaths: Set<string>,
-    removedHtmlAssetPaths: Set<string>,
-  ): void {
-    const previousRecord = this.getCachedRecord(filePath);
-    const nextOutputPaths = new Set(record.outputs.keys());
-
-    for (const outputPath of previousRecord?.outputs.keys() ?? []) {
-      if (nextOutputPaths.has(outputPath)) {
-        continue;
-      }
-      removedOutputRelPaths.add(outputPath);
-      if (outputPath.endsWith('.html')) {
-        removedHtmlAssetPaths.add(outputPath);
-      }
-    }
-
-    for (const outputPath of record.outputs.keys()) {
-      changedOutputRelPaths.add(outputPath);
-      if (outputPath.endsWith('.html')) {
-        changedHtmlAssetPaths.add(outputPath);
-      }
-    }
-
-    this.sourceFileCache.set(filePath, record);
-  }
-
-  writeCachedAssets(distDir: string, buildContentFiles: string[]): void {
-    for (const filePath of buildContentFiles) {
-      const record = this.getCachedRecord(filePath);
-      if (!record) {
-        continue;
-      }
-      for (const [outputPath, content] of record.outputs) {
-        const outPath = path.join(distDir, outputPath);
-        fs.mkdirSync(path.dirname(outPath), { recursive: true });
-        fs.writeFileSync(outPath, content);
-      }
-    }
-  }
-
-  pruneRemovedSources(
-    buildFileSet: Set<string>,
-    removedOutputRelPaths: Set<string>,
-    removedHtmlAssetPaths: Set<string>,
-  ): void {
-    for (const filePath of [...this.lastBuildFiles]) {
-      if (buildFileSet.has(filePath)) {
-        continue;
-      }
-
-      const previousRecord = this.getCachedRecord(filePath);
-      for (const outputPath of previousRecord?.outputs.keys() ?? []) {
-        removedOutputRelPaths.add(outputPath);
-        if (outputPath.endsWith('.html')) {
-          removedHtmlAssetPaths.add(outputPath);
-        }
-      }
-      this.sourceFileCache.delete(filePath);
-    }
-  }
-
   processContent({
     distDir,
     assetFiles,
     scan,
-    watchState,
   }: ContentRenderOptions): ContentRenderResult {
     const buildContentFiles = [...scan.buildContentFiles];
-    const buildFileSet = new Set<string>(buildContentFiles);
-    const dirtySourceFiles = this.getDirtySourceFiles(
-      buildContentFiles,
-      watchState,
-    );
-    const changedOutputRelPaths = new Set<string>();
-    const removedOutputRelPaths = new Set<string>();
-    const changedHtmlAssetPaths = new Set<string>();
-    const removedHtmlAssetPaths = new Set<string>();
     const validInternalTargets = scan.validTargets;
 
     const errors: Error[] = [];
+    const htmlAssetsByPath = new Map<string, string>();
+    const htmlAnalysisByPath = new Map<string, HtmlOutputAnalysis>();
 
     const configLinkErrors = validateConfigLinks(
       validInternalTargets,
@@ -185,29 +81,21 @@ export class ContentRenderer {
       errors.push(new Error(msg));
     }
 
-    this.pruneRemovedSources(
-      buildFileSet,
-      removedOutputRelPaths,
-      removedHtmlAssetPaths,
-    );
-
-    if (dirtySourceFiles.size > 0) {
-      const noun = dirtySourceFiles.size === 1 ? 'file' : 'files';
-      log.info`Processing ${dirtySourceFiles.size} content ${noun}`;
+    if (buildContentFiles.length > 0) {
+      const noun = buildContentFiles.length === 1 ? 'file' : 'files';
+      log.info`Processing ${buildContentFiles.length} content ${noun}`;
     }
 
-    if (this.javacAvailable === undefined && dirtySourceFiles.size > 0) {
+    if (!this.traceToolAvailability && buildContentFiles.length > 0) {
       this.traceToolAvailability = checkTraceToolAvailability();
-      this.javacAvailable = this.traceToolAvailability.java;
-      if (!this.javacAvailable) {
+      if (!this.traceToolAvailability.java) {
         log.warn`javac was not found; literate Java pages will not include execution output`;
       }
     }
 
-    for (const filePath of dirtySourceFiles) {
-      let record: TadaSourceRecord;
+    for (const filePath of buildContentFiles) {
       try {
-        record = createContentRecord({
+        const record = createContentRecord({
           filePath,
           siteVariables: this.siteVariables,
           scan,
@@ -215,53 +103,27 @@ export class ContentRenderer {
           outputDir: distDir,
           traceCache: this.traceCache,
           traceToolAvailability: this.traceToolAvailability,
-          skipLiterateJavaExecution: !this.javacAvailable,
+          skipLiterateJavaExecution: !this.traceToolAvailability?.java,
         });
+        writeRecordOutputs(distDir, record.outputs);
+        for (const [outputPath, content] of record.outputs) {
+          if (!outputPath.endsWith('.html') || typeof content !== 'string') {
+            continue;
+          }
+          htmlAssetsByPath.set(outputPath, content);
+          const analysis = record.htmlAnalysisByOutputPath?.get(outputPath);
+          if (analysis) {
+            htmlAnalysisByPath.set(
+              outputPath,
+              cloneHtmlOutputAnalysis(analysis),
+            );
+          }
+        }
       } catch (err) {
         errors.push(err as Error);
-        continue;
-      }
-      this.updateSourceCache(
-        filePath,
-        record,
-        changedOutputRelPaths,
-        removedOutputRelPaths,
-        changedHtmlAssetPaths,
-        removedHtmlAssetPaths,
-      );
-    }
-
-    this.writeCachedAssets(distDir, buildContentFiles);
-    this.lastBuildFiles = buildFileSet;
-
-    // Collect HTML asset content and analysis for Pagefind
-    const htmlAssetsByPath = new Map<string, string>();
-    const htmlAnalysisByPath = new Map<string, HtmlOutputAnalysis>();
-    for (const filePath of buildContentFiles) {
-      const record = this.getCachedRecord(filePath);
-      if (!record) {
-        continue;
-      }
-      for (const [outputPath, content] of record.outputs) {
-        if (!outputPath.endsWith('.html') || typeof content !== 'string') {
-          continue;
-        }
-        htmlAssetsByPath.set(outputPath, content);
-        const analysis = record.htmlAnalysisByOutputPath?.get(outputPath);
-        if (analysis) {
-          htmlAnalysisByPath.set(outputPath, cloneHtmlOutputAnalysis(analysis));
-        }
       }
     }
 
-    return {
-      errors,
-      changedHtmlAssetPaths,
-      removedHtmlAssetPaths,
-      removedOutputRelPaths,
-      htmlAssetsByPath,
-      htmlAnalysisByPath,
-      buildContentFiles,
-    };
+    return { errors, htmlAssetsByPath, htmlAnalysisByPath };
   }
 }

package/build/pipeline.ts

@@ -15,7 +15,7 @@ import { makeLogger, printFlair } from './log';
 import { generateBuildManifest, getNextVersion } from './build-manifest';
 import { scanProject } from './source-model';
 import { validateConfig } from './watch/validation';
-import { applyCommitPlan } from '../watch/fs-commit';
+import { applyCommitPlan } from './watch/fs-commit';
 import path from 'path';
 
 const log = makeLogger(import.meta.url);

package/build/source-model.ts

@@ -15,7 +15,7 @@ import {
   normalizeOutputPath,
   toPosix,
 } from './utils/paths';
-import type { ChangeBatch } from '../watch/types';
+import type { ChangeBatch } from './watch/types';
 import type { SiteVariables } from './types';
 
 export interface TadaProjectScan {
@@ -34,18 +34,6 @@ export interface TadaProjectScan {
   sourceTargetPaths: Map<string, Set<string>>;
 }
 
-export interface TadaProjectScanSnapshotLike {
-  processedExts: Set<string>;
-  contentFiles: Set<string>;
-  buildContentFiles: Set<string>;
-  publicFiles: Set<string>;
-  literateJavaOutputPaths: Set<string>;
-  contentOwners: Map<string, string>;
-  publicOwners: Map<string, string>;
-  sourceOutputPaths: Map<string, Set<string>>;
-  sourceTargetPaths: Map<string, Set<string>>;
-}
-
 export function shouldSkipContentFile(filePath: string): boolean {
   const ext = path.extname(filePath).toLowerCase();
   if (!(extensionIsMarkdown(ext) || ext === '.html')) {
@@ -333,7 +321,7 @@ export function scanProject(siteVariables: SiteVariables): TadaProjectScan {
 }
 
 export function updateProjectScan(
-  snapshot: TadaProjectScanSnapshotLike,
+  snapshot: TadaProjectScan,
   batch: ChangeBatch,
 ): TadaProjectScan {
   const scan = createEmptyScan(snapshot.processedExts);

package/build/types.d.ts

@@ -49,25 +49,13 @@ export interface ContentRenderOptions {
   distDir: string;
   assetFiles: string[];
   scan: TadaProjectScan;
-  watchState?: WatchState;
-}
-
-/** State passed from watch mode to control incremental rebuilds */
-export interface WatchState {
-  changedContentFiles?: Set<string>;
-  jsonDataChanged?: boolean;
-  partialsChanged?: boolean;
 }
 
 /** Result from ContentRenderer.processContent() */
 export interface ContentRenderResult {
   errors: Error[];
-  changedHtmlAssetPaths: Set<string>;
-  removedHtmlAssetPaths: Set<string>;
-  removedOutputRelPaths: Set<string>;
   htmlAssetsByPath: Map<string, string>;
   htmlAnalysisByPath: Map<string, HtmlOutputAnalysis>;
-  buildContentFiles: string[];
 }
 
 /** Logger returned by makeLogger() */

package/build/watch/build-full.ts

@@ -1,34 +1,24 @@
 import { compileTemplates, config } from '../templates';
 import { getDevSiteVariables } from '../site-variables';
-import { createContentRecord, createPublicRecord } from '../source-records';
 import { getDistDir } from '../util';
-import type { CompilerBuildResult } from '../../watch/types';
-import {
-  collectHtmlAnalysisByPath,
-  collectHtmlAssetsByPath,
-  createSnapshot,
-  type TadaSourceRecord,
-  type TadaSnapshot,
-} from './snapshot';
+import type { CompilerBuildResult } from './types';
+import { createSnapshot, type TadaSourceRecord } from './snapshot';
 import { scanProject } from '../source-model';
-import type {
-  TadaBuildMeta,
-  TraceCache,
-  WatchTraceOptions,
-} from './compiler-types';
+import type { TraceCache, WatchTraceOptions } from './compiler-types';
 import {
   bundleWatchAssets,
   ensureHighlighter,
   makeTempBuildDir,
   populateStaticAssets,
   removeDirIfExists,
-  writeAssets,
 } from './assets';
+import { validateConfig, validateProjectConfigLinks } from './validation';
+import { buildFailedFromError, buildSucceeded } from './build-result';
 import {
-  diagnosticsFromMessages,
-  validateConfig,
-  validateProjectConfigLinks,
-} from './validation';
+  buildFailedWithDiagnostics,
+  renderContentRecord,
+  renderPublicRecord,
+} from './build-helpers';
 
 export async function buildFull({
   traceCache,
@@ -36,7 +26,7 @@ export async function buildFull({
 }: {
   traceCache: TraceCache;
   traceOptions: WatchTraceOptions;
-}): Promise<CompilerBuildResult<TadaSnapshot, TadaBuildMeta>> {
+}): Promise<CompilerBuildResult> {
   const distDir = getDistDir();
   const outputDir = makeTempBuildDir(distDir);
   try {
@@ -44,8 +34,7 @@ export async function buildFull({
     const scan = scanProject(siteVariables);
     const configDiagnostics = validateConfig(scan);
     if (configDiagnostics.length > 0) {
-      removeDirIfExists(outputDir);
-      return { ok: false, diagnostics: configDiagnostics };
+      return buildFailedWithDiagnostics(outputDir, configDiagnostics);
     }
 
     compileTemplates(siteVariables);
@@ -56,33 +45,34 @@ export async function buildFull({
 
     const contentRecords = new Map<string, TadaSourceRecord>();
     for (const filePath of scan.contentFiles) {
-      const record = createContentRecord({
+      const record = renderContentRecord({
         filePath,
         siteVariables,
         scan,
         assetFiles,
         outputDir,
         traceCache,
-        traceToolAvailability: traceOptions.toolAvailability,
+        traceOptions,
         cachedTraceSourceDir: distDir,
       });
-      if (record.outputs.size > 0) {
-        writeAssets(outputDir, record.outputs);
+      if (record) {
         contentRecords.set(filePath, record);
       }
     }
 
     const publicRecords = new Map<string, TadaSourceRecord>();
     for (const filePath of scan.publicFiles) {
-      const record = createPublicRecord(filePath, scan.publicDir);
-      writeAssets(outputDir, record.outputs);
+      const record = renderPublicRecord({
+        filePath,
+        publicDir: scan.publicDir,
+        outputDir,
+      });
       publicRecords.set(filePath, record);
     }
 
     const linkDiagnostics = validateProjectConfigLinks(scan.validTargets);
     if (linkDiagnostics.length > 0) {
-      removeDirIfExists(outputDir);
-      return { ok: false, diagnostics: linkDiagnostics };
+      return buildFailedWithDiagnostics(outputDir, linkDiagnostics);
     }
 
     const nextSnapshot = createSnapshot({
@@ -95,29 +85,13 @@ export async function buildFull({
       publicRecords,
     });
 
-    return {
-      ok: true,
-      snapshot: nextSnapshot,
-      commit: {
-        kind: 'replace-root',
-        stagedPath: outputDir,
-        targetPath: distDir,
-      },
-      meta: {
-        htmlAssetsByPath: collectHtmlAssetsByPath(nextSnapshot.contentRecords),
-        htmlAnalysisByPath: collectHtmlAnalysisByPath(
-          nextSnapshot.contentRecords,
-        ),
-        siteVariables,
-      },
-    };
+    return buildSucceeded(nextSnapshot, {
+      kind: 'replace-root',
+      stagedPath: outputDir,
+      targetPath: distDir,
+    });
   } catch (error) {
     removeDirIfExists(outputDir);
-    return {
-      ok: false,
-      diagnostics: diagnosticsFromMessages([
-        error instanceof Error ? error.message : String(error),
-      ]),
-    };
+    return buildFailedFromError(error);
   }
 }

package/build/watch/build-helpers.ts

@@ -0,0 +1,66 @@
+import { createContentRecord, createPublicRecord } from '../source-records';
+import type { SiteVariables } from '../types';
+import type { TadaProjectScan, TadaSourceRecord } from './snapshot';
+import type { CompilerBuildResult, WatchDiagnostic } from './types';
+import type { TraceCache, WatchTraceOptions } from './compiler-types';
+import { removeDirIfExists, writeAssets } from './assets';
+
+export function buildFailedWithDiagnostics(
+  outputDir: string,
+  diagnostics: WatchDiagnostic[],
+): CompilerBuildResult {
+  removeDirIfExists(outputDir);
+  return { ok: false, diagnostics };
+}
+
+export function renderContentRecord({
+  filePath,
+  siteVariables,
+  scan,
+  assetFiles,
+  outputDir,
+  traceCache,
+  traceOptions,
+  cachedTraceSourceDir,
+}: {
+  filePath: string;
+  siteVariables: SiteVariables;
+  scan: TadaProjectScan;
+  assetFiles: string[];
+  outputDir: string;
+  traceCache: TraceCache;
+  traceOptions: WatchTraceOptions;
+  cachedTraceSourceDir: string;
+}): TadaSourceRecord | undefined {
+  const record = createContentRecord({
+    filePath,
+    siteVariables,
+    scan,
+    assetFiles,
+    outputDir,
+    traceCache,
+    traceToolAvailability: traceOptions.toolAvailability,
+    cachedTraceSourceDir,
+  });
+  if (record.outputs.size === 0) {
+    return undefined;
+  }
+  writeAssets(outputDir, record.outputs);
+  return record;
+}
+
+export function renderPublicRecord({
+  filePath,
+  publicDir,
+  outputDir,
+}: {
+  filePath: string;
+  publicDir: string;
+  outputDir?: string;
+}): TadaSourceRecord {
+  const record = createPublicRecord(filePath, publicDir);
+  if (outputDir) {
+    writeAssets(outputDir, record.outputs);
+  }
+  return record;
+}