@abreen/tada 1.13.7 → 1.14.1

package/build/watch/planner.ts

@@ -1,16 +1,12 @@
 import path from 'path';
-import {
-  getProjectConfigBaseName,
-  getSiteConfigBaseName,
-  getSupportedConfigFilePaths,
-} from '../config-files';
 import { loadProjectConfig } from '../config-loader';
 import { getProjectConfigDir } from '../templates';
-import type { ChangeBatch } from '../../watch/types';
+import type { ChangeBatch } from './types';
 import type { TadaProjectScan, TadaSnapshot } from './snapshot';
+import { classifyWatchConfigPath } from './config-paths';
 
-export interface TadaWatchPlan {
-  kind: 'full' | 'incremental';
+export interface TadaIncrementalWatchPlan {
+  kind: 'incremental';
   scan: TadaProjectScan;
   contentToRender: Set<string>;
   publicToRender: Set<string>;
@@ -18,6 +14,8 @@ export interface TadaWatchPlan {
   publicToRemove: Set<string>;
 }
 
+export type TadaWatchPlan = { kind: 'full' } | TadaIncrementalWatchPlan;
+
 export function diffAuthorKeys(previous: unknown, next: unknown): Set<string> {
   const previousMap =
     previous && typeof previous === 'object'
@@ -60,7 +58,7 @@ export function createTadaWatchPlan({
   batch,
   scan,
 }: {
-  snapshot: TadaSnapshot | undefined;
+  snapshot: TadaSnapshot;
   batch: ChangeBatch;
   scan: TadaProjectScan;
 }): TadaWatchPlan {
@@ -69,66 +67,24 @@ export function createTadaWatchPlan({
   const contentToRemove = new Set<string>();
   const publicToRemove = new Set<string>();
   const projectConfigDir = getProjectConfigDir();
-  const siteConfigPaths = new Set(
-    getSupportedConfigFilePaths('.', getSiteConfigBaseName('dev')).map(
-      filePath => path.resolve(filePath),
-    ),
-  );
-  const navPaths = new Set(
-    getSupportedConfigFilePaths(
-      projectConfigDir,
-      getProjectConfigBaseName('nav'),
-    ).map(filePath => path.resolve(filePath)),
-  );
-  const authorsPaths = new Set(
-    getSupportedConfigFilePaths(
-      projectConfigDir,
-      getProjectConfigBaseName('authors'),
-    ).map(filePath => path.resolve(filePath)),
-  );
-
-  if (!snapshot) {
-    return {
-      kind: 'full',
-      scan,
-      contentToRender,
-      publicToRender,
-      contentToRemove,
-      publicToRemove,
-    };
-  }
 
   for (const change of batch.changes) {
-    const resolvedPath = path.resolve(change.path);
-    if (siteConfigPaths.has(resolvedPath) || navPaths.has(resolvedPath)) {
-      return {
-        kind: 'full',
-        scan,
-        contentToRender,
-        publicToRender,
-        contentToRemove,
-        publicToRemove,
-      };
+    const configKind = classifyWatchConfigPath(change.path);
+    if (configKind === 'site' || configKind === 'nav') {
+      return { kind: 'full' };
     }
   }
 
   for (const change of batch.changes) {
     const resolvedPath = path.resolve(change.path);
-    if (authorsPaths.has(resolvedPath)) {
+    if (classifyWatchConfigPath(resolvedPath) === 'authors') {
       const nextAuthorsData = loadProjectConfig(
         projectConfigDir,
         'authors',
         snapshot.siteVariables,
       )?.value;
       if (snapshot.authorsData === undefined || nextAuthorsData === undefined) {
-        return {
-          kind: 'full',
-          scan,
-          contentToRender,
-          publicToRender,
-          contentToRemove,
-          publicToRemove,
-        };
+        return { kind: 'full' };
       }
       const changedAuthorKeys = diffAuthorKeys(
         snapshot.authorsData,
@@ -144,17 +100,6 @@ export function createTadaWatchPlan({
       contentToRender.add(resolvedPath);
     } else if (snapshot.contentRecords.has(resolvedPath)) {
       contentToRemove.add(resolvedPath);
-      const previousRecord = snapshot.contentRecords.get(resolvedPath)!;
-      for (const partialPath of previousRecord.partialDeps) {
-        addDependents(
-          contentToRender,
-          snapshot.reversePartialDeps,
-          partialPath,
-        );
-      }
-      for (const tracePath of previousRecord.traceDeps) {
-        addDependents(contentToRender, snapshot.reverseTraceDeps, tracePath);
-      }
     }
 
     if (scan.publicFiles.has(resolvedPath)) {
@@ -168,15 +113,13 @@ export function createTadaWatchPlan({
   }
 
   const changedTargets = new Set<string>();
-  const removedTargets = new Set<string>();
-  for (const target of snapshot.validTargets) {
+  for (const target of snapshot.scan.validTargets) {
     if (!scan.validTargets.has(target)) {
       changedTargets.add(target);
-      removedTargets.add(target);
     }
   }
   for (const target of scan.validTargets) {
-    if (!snapshot.validTargets.has(target)) {
+    if (!snapshot.scan.validTargets.has(target)) {
       changedTargets.add(target);
     }
   }
@@ -184,13 +127,6 @@ export function createTadaWatchPlan({
     addDependents(contentToRender, snapshot.reverseInternalTargetDeps, target);
   }
 
-  if (removedTargets.size > 0 && contentToRender.size === 0) {
-    const rootOwner = snapshot.outputOwners.get('index.html');
-    if (rootOwner?.kind === 'content') {
-      contentToRender.add(rootOwner.sourcePath);
-    }
-  }
-
   for (const [outputPath, owner] of snapshot.outputOwners) {
     const nextContentOwner = scan.contentOwners.get(outputPath);
     const nextPublicOwner = scan.publicOwners.get(outputPath);

package/build/watch/runtime.ts

@@ -3,9 +3,7 @@ import { B } from '../colors';
 import { makeLogger, printFlair } from '../log';
 import { startServer } from '../serve';
 import { WatchPagefindRunner } from '../pagefind';
-import type { TadaBuildMeta } from './compiler-types';
-import type { TadaSnapshot } from './snapshot';
-import type { WatchLifecycleEvent } from '../../watch/types';
+import type { WatchLifecycleEvent } from './types';
 import {
   WATCH_RELOAD_MESSAGE_REBUILDING,
   WATCH_RELOAD_MESSAGE_RELOAD,
@@ -30,7 +28,6 @@ export class TadaWatchRuntime {
   private httpPort: number | undefined;
   private distDir: string;
   private server: Bun.Server<undefined> | null;
-  private lastBuildFailed: boolean;
   private pagefindRunner: WatchPagefindRunner | undefined;
   private pagefindSiteVariablesKey: string | undefined;
 
@@ -38,7 +35,6 @@ export class TadaWatchRuntime {
     this.httpPort = httpPort;
     this.distDir = distDir;
     this.server = null;
-    this.lastBuildFailed = false;
     this.pagefindSiteVariablesKey = undefined;
   }
 
@@ -68,51 +64,45 @@ export class TadaWatchRuntime {
     wslog.debug`WebSocket server listening at ws://localhost:${this.server.port}${WATCH_RELOAD_PATH}`;
   }
 
-  async onEvent(
-    event: WatchLifecycleEvent<TadaSnapshot, TadaBuildMeta>,
-  ): Promise<void> {
+  async onEvent(event: WatchLifecycleEvent): Promise<void> {
     switch (event.kind) {
       case 'build-started':
-        if (!event.initial) {
-          for (const change of event.batch?.changes || []) {
-            log.event`${B`${path.basename(change.path)}`} ${describeChange(change.kind)}`;
-          }
-          this.broadcast(WATCH_RELOAD_MESSAGE_REBUILDING);
+        if (!event.batch) {
+          return;
+        }
+        for (const change of event.batch.changes) {
+          log.event`${B`${path.basename(change.path)}`} ${describeChange(change.kind)}`;
         }
+        this.broadcast(WATCH_RELOAD_MESSAGE_REBUILDING);
         return;
       case 'build-succeeded': {
-        const recoveredFromFailure = this.lastBuildFailed;
-        this.lastBuildFailed = false;
         printFlair();
         this.ensureServerStarted();
-        if (!event.initial && (event.changed || recoveredFromFailure)) {
+        if (event.batch) {
           this.broadcast(WATCH_RELOAD_MESSAGE_RELOAD);
         }
-        if (event.meta && event.changed) {
-          if (event.meta.siteVariables.features.search !== false) {
-            const siteVariablesKey = JSON.stringify(event.meta.siteVariables);
-            if (
-              !this.pagefindRunner ||
-              this.pagefindSiteVariablesKey !== siteVariablesKey
-            ) {
-              this.pagefindRunner = new WatchPagefindRunner();
-              this.pagefindSiteVariablesKey = siteVariablesKey;
-            }
-            this.pagefindRunner.update(
-              this.distDir,
-              event.meta.htmlAssetsByPath,
-              event.meta.htmlAnalysisByPath,
-            );
-            setImmediate(() => this.pagefindRunner!.run());
-          } else {
-            this.pagefindRunner = undefined;
-            this.pagefindSiteVariablesKey = undefined;
+        if (event.meta.siteVariables.features.search !== false) {
+          const siteVariablesKey = JSON.stringify(event.meta.siteVariables);
+          if (
+            !this.pagefindRunner ||
+            this.pagefindSiteVariablesKey !== siteVariablesKey
+          ) {
+            this.pagefindRunner = new WatchPagefindRunner();
+            this.pagefindSiteVariablesKey = siteVariablesKey;
           }
+          this.pagefindRunner.update(
+            this.distDir,
+            event.meta.htmlAssetsByPath,
+            event.meta.htmlAnalysisByPath,
+          );
+          setImmediate(() => this.pagefindRunner!.run());
+        } else {
+          this.pagefindRunner = undefined;
+          this.pagefindSiteVariablesKey = undefined;
         }
         return;
       }
       case 'build-failed':
-        this.lastBuildFailed = true;
         for (const diagnostic of event.diagnostics) {
           log.error`${diagnostic.message}`;
         }
@@ -120,8 +110,6 @@ export class TadaWatchRuntime {
       case 'watching':
         log.info`Watching for changes...`;
         return;
-      case 'build-skipped':
-        return;
     }
   }
 }

package/build/watch/snapshot.ts

@@ -8,6 +8,7 @@ import {
   updateProjectScan,
 } from '../source-model';
 import type { Asset, HtmlOutputAnalysis, SiteVariables } from '../types';
+import type { TadaBuildMeta } from './compiler-types';
 
 export interface TadaSourceRecord {
   sourcePath: string;
@@ -21,28 +22,24 @@ export interface TadaSourceRecord {
   authorKey?: string;
 }
 
+export interface TadaOutputOwner {
+  kind: 'content' | 'public';
+  sourcePath: string;
+}
+
 export interface TadaSnapshot {
   siteVariables: SiteVariables;
   assetFiles: string[];
   navData: unknown;
   authorsData: unknown;
-  processedExts: Set<string>;
   contentRecords: Map<string, TadaSourceRecord>;
   publicRecords: Map<string, TadaSourceRecord>;
-  outputOwners: Map<string, { kind: 'content' | 'public'; sourcePath: string }>;
+  outputOwners: Map<string, TadaOutputOwner>;
   reversePartialDeps: Map<string, Set<string>>;
   reverseTraceDeps: Map<string, Set<string>>;
   reverseInternalTargetDeps: Map<string, Set<string>>;
   reverseAuthorDeps: Map<string, 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>>;
-  validTargets: Set<string>;
+  scan: TadaProjectScan;
 }
 
 function buildReverseMap(
@@ -63,22 +60,11 @@ function buildReverseMap(
   return reverse;
 }
 
-function cloneSetMap(
-  source: Map<string, Set<string>>,
-): Map<string, Set<string>> {
-  return new Map(
-    [...source.entries()].map(([key, values]) => [key, new Set(values)]),
-  );
-}
-
 export function collectOutputOwners(snapshot: {
   contentRecords: Map<string, TadaSourceRecord>;
   publicRecords: Map<string, TadaSourceRecord>;
-}): Map<string, { kind: 'content' | 'public'; sourcePath: string }> {
-  const owners = new Map<
-    string,
-    { kind: 'content' | 'public'; sourcePath: string }
-  >();
+}): Map<string, TadaOutputOwner> {
+  const owners = new Map<string, TadaOutputOwner>();
 
   for (const record of snapshot.contentRecords.values()) {
     for (const outputPath of record.outputs.keys()) {
@@ -116,23 +102,12 @@ export function createSnapshot({
   publicRecords: Map<string, TadaSourceRecord>;
 }): TadaSnapshot {
   const allRecords = [...contentRecords.values()];
-  const reverseAuthorDeps = new Map<string, Set<string>>();
-  for (const record of allRecords) {
-    if (!record.authorKey) {
-      continue;
-    }
-    if (!reverseAuthorDeps.has(record.authorKey)) {
-      reverseAuthorDeps.set(record.authorKey, new Set());
-    }
-    reverseAuthorDeps.get(record.authorKey)!.add(record.sourcePath);
-  }
 
   return {
     siteVariables,
     assetFiles,
     navData,
     authorsData,
-    processedExts: scan.processedExts,
     contentRecords,
     publicRecords,
     outputOwners: collectOutputOwners({ contentRecords, publicRecords }),
@@ -145,16 +120,10 @@ export function createSnapshot({
       allRecords,
       record => record.internalTargets,
     ),
-    reverseAuthorDeps,
-    contentFiles: new Set(scan.contentFiles),
-    buildContentFiles: new Set(scan.buildContentFiles),
-    publicFiles: new Set(scan.publicFiles),
-    literateJavaOutputPaths: new Set(scan.literateJavaOutputPaths),
-    contentOwners: new Map(scan.contentOwners),
-    publicOwners: new Map(scan.publicOwners),
-    sourceOutputPaths: cloneSetMap(scan.sourceOutputPaths),
-    sourceTargetPaths: cloneSetMap(scan.sourceTargetPaths),
-    validTargets: new Set(scan.validTargets),
+    reverseAuthorDeps: buildReverseMap(allRecords, record =>
+      record.authorKey ? [record.authorKey] : [],
+    ),
+    scan,
   };
 }
 
@@ -214,14 +183,24 @@ export function collectHtmlAnalysisByPath(
 ): Map<string, HtmlOutputAnalysis> {
   const htmlAnalysisByPath = new Map<string, HtmlOutputAnalysis>();
   for (const record of contentRecords.values()) {
-    for (const [outputPath, analysis] of record.htmlAnalysisByOutputPath ||
-      new Map<string, HtmlOutputAnalysis>()) {
+    if (!record.htmlAnalysisByOutputPath) {
+      continue;
+    }
+    for (const [outputPath, analysis] of record.htmlAnalysisByOutputPath) {
       htmlAnalysisByPath.set(outputPath, cloneHtmlOutputAnalysis(analysis));
     }
   }
   return htmlAnalysisByPath;
 }
 
+export function createBuildMeta(snapshot: TadaSnapshot): TadaBuildMeta {
+  return {
+    htmlAssetsByPath: collectHtmlAssetsByPath(snapshot.contentRecords),
+    htmlAnalysisByPath: collectHtmlAnalysisByPath(snapshot.contentRecords),
+    siteVariables: snapshot.siteVariables,
+  };
+}
+
 export function normalizeInternalTarget(target: string): string {
   return normalizeOutputPath(target);
 }

package/build/watch/types.d.ts

@@ -0,0 +1,84 @@
+import type { ChokidarOptions } from 'chokidar';
+import type { TadaBuildMeta } from './compiler-types';
+import type { TadaSnapshot } from './snapshot';
+
+export type WatchEventKind = 'add' | 'change' | 'unlink';
+
+export interface FileChange {
+  path: string;
+  kind: WatchEventKind;
+}
+
+export interface ChangeBatch {
+  changes: FileChange[];
+}
+
+export interface WatchTarget {
+  path: string;
+  chokidar?: ChokidarOptions;
+  filter?: (filePath: string) => boolean;
+}
+
+export interface WatchDiagnostic {
+  message: string;
+}
+
+export interface WriteFileMutation {
+  kind: 'write';
+  path: string;
+  content: string | Buffer;
+}
+
+export interface DeleteFileMutation {
+  kind: 'delete';
+  path: string;
+}
+
+export type FileMutation = WriteFileMutation | DeleteFileMutation;
+
+export interface ReplaceRootCommitPlan {
+  kind: 'replace-root';
+  stagedPath: string;
+  targetPath: string;
+}
+
+export interface ApplyMutationsCommitPlan {
+  kind: 'apply-mutations';
+  rootDir: string;
+  mutations: FileMutation[];
+}
+
+export type CommitPlan = ReplaceRootCommitPlan | ApplyMutationsCommitPlan;
+
+export type CompilerBuildResult =
+  | {
+      ok: true;
+      snapshot: TadaSnapshot;
+      commit: CommitPlan;
+      meta: TadaBuildMeta;
+    }
+  | { ok: false; diagnostics: WatchDiagnostic[] };
+
+export interface WatchCompiler {
+  getWatchTargets(): WatchTarget[];
+  build(
+    snapshot: TadaSnapshot | undefined,
+    batch?: ChangeBatch,
+  ): Promise<CompilerBuildResult>;
+}
+
+export type WatchLifecycleEvent =
+  | { kind: 'watching' }
+  | { kind: 'build-started'; batch?: ChangeBatch }
+  | { kind: 'build-succeeded'; batch?: ChangeBatch; meta: TadaBuildMeta }
+  | {
+      kind: 'build-failed';
+      batch?: ChangeBatch;
+      diagnostics: WatchDiagnostic[];
+    };
+
+export interface WatchEngineOptions {
+  compiler: WatchCompiler;
+  debounceMs?: number;
+  onEvent?: (event: WatchLifecycleEvent) => void | Promise<void>;
+}

package/build/watch/validation.ts

@@ -2,7 +2,7 @@ import { B } from '../colors';
 import { makeLogger } from '../log';
 import { config, getConfigFileName } from '../templates';
 import { validateConfigLinks } from '../validate-config-links';
-import type { WatchDiagnostic } from '../../watch/types';
+import type { WatchDiagnostic } from './types';
 import { assertNoOutputPathConflicts, type TadaProjectScan } from './snapshot';
 
 const log = makeLogger(import.meta.url);

package/init/content/lectures/02/_pr1.md

@@ -2,4 +2,4 @@
 
 Here's the `_pr1.md` partial. From this partial we can use the page-level
 front matter fields from the page that includes us. The page that called
-`include()` has a title of: <%= page.title %>
+this partial has a title of: <%= page.title %>

package/init/content/lectures/02/index.md

@@ -8,6 +8,6 @@ author: alex
 
 Here is a page constructed from multiple partials.
 
-<%= include('_pr1.md') %>
+{{{ _pr1.md }}}
 
-<%= include('subdir/_pr2.md') %>
+{{{ subdir/_pr2.md }}}

package/init/content/lectures/02/subdir/_foobar.md

@@ -0,0 +1,3 @@
+Here's a nested Markdown partial in a subdirectory.
+
+Here's the title of the page including this partial: <%= page.title %>

package/init/content/lectures/02/subdir/_pr2.md

@@ -1,6 +1,6 @@
 ## Problem 2 # The second example problem
 
-Here's the `_pr2.md` partial. If we use `include()` here, the path is resolved
-relative to this file, **not** the page or partial that included us.
+Here's the `_pr2.md` partial. If we include another partial here, the path is
+resolved relative to this file, **not** the page or partial that included us.
 
-<%= include('_foobar.html') %>
+{{{ _foobar.md }}}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abreen/tada",
-  "version": "1.13.7",
+  "version": "1.14.1",
   "type": "module",
   "description": "A static site generator",
   "license": "MIT",
@@ -15,7 +15,6 @@
   "files": [
     "bin/",
     "build/",
-    "watch/",
     "src/",
     "templates/",
     "fonts/",

package/src/slides/index.ts

@@ -249,8 +249,8 @@ export default function mountSlides(window: Window): void | (() => void) {
     }
   }
 
-  function resetReadyTraces(): void {
-    const widgets = slidesRoot.querySelectorAll(
+  function resetReadyTraces(scope: HTMLElement = slidesRoot): void {
+    const widgets = scope.querySelectorAll(
       '.trace-widget:not(.trace-disabled)',
     );
 
@@ -341,7 +341,11 @@ export default function mountSlides(window: Window): void | (() => void) {
       hidePresentationControls();
     }
 
+    const previousIndex = activeIndex;
     setActiveSlide(activeIndex + delta);
+    if (delta === -1 && activeIndex !== previousIndex) {
+      resetReadyTraces(slides[activeIndex]);
+    }
     focusSlide(slides[activeIndex]);
   }