@abreen/tada 1.5.7 → 1.6.0

package/README.md

@@ -1,5 +1,8 @@
 # Tada :tada:
 
+[![CI/CD](https://github.com/abreen/Tada/actions/workflows/ci.yml/badge.svg)](https://github.com/abreen/Tada/actions/workflows/ci.yml)
+[![npm version](https://img.shields.io/npm/v/%40abreen%2Ftada)](https://www.npmjs.com/package/@abreen/tada)
+
 A static site generator. The successor to Presto.
 
 ## Features

package/build/build-manifest.ts

@@ -1,5 +1,6 @@
 import fs from 'fs';
 import path from 'path';
+import { toPosix } from './utils/paths';
 
 const EXCLUDED_DIRS = new Set(['pagefind']);
 const EXCLUDED_FILES = new Set(['tada.manifest.json']);
@@ -68,7 +69,7 @@ export async function walkAndHash(
     }
 
     const abs = path.join(entry.parentPath, entry.name);
-    const rel = path.relative(dir, abs).split(path.sep).join(path.posix.sep);
+    const rel = toPosix(path.relative(dir, abs));
 
     const topLevel = rel.split('/')[0];
     if (EXCLUDED_DIRS.has(topLevel)) {

package/build/bundle.ts

@@ -3,7 +3,12 @@ import os from 'os';
 import path from 'path';
 import _ from 'lodash';
 import * as sass from 'sass';
-import { getPackageDir, getProjectDir, getDistDir } from './utils/paths';
+import {
+  getPackageDir,
+  getProjectDir,
+  getDistDir,
+  toPosix,
+} from './utils/paths';
 import { deriveTheme } from './utils/derive-theme';
 import type { PluginBuilder } from 'bun';
 import type { SiteVariables } from './types';
@@ -104,10 +109,7 @@ export async function bundle(
 
   // Return the output filenames for asset tag injection
   const assetFiles = result.outputs.map(output =>
-    path
-      .relative(resolvedDistDir, output.path)
-      .split(path.sep)
-      .join(path.posix.sep),
+    toPosix(path.relative(resolvedDistDir, output.path)),
   );
 
   return assetFiles;

package/build/copy.ts

@@ -1,5 +1,6 @@
 import fs from 'fs';
 import path from 'path';
+import { toPosix } from './utils/paths';
 import { makeLogger } from './log';
 import { B } from './colors';
 
@@ -22,7 +23,7 @@ function collectFiles(dir: string): CollectedFile[] {
     .map(entry => {
       const abs = path.join(entry.parentPath, entry.name);
       const rel = path.relative(dir, abs);
-      return { abs, rel: rel.split(path.sep).join(path.posix.sep) };
+      return { abs, rel: toPosix(rel) };
     });
 }
 
@@ -83,10 +84,7 @@ export function copyPublicFile(
   filePath: string,
   contentAssetRelPaths?: Set<string>,
 ): void {
-  const rel = path
-    .relative(publicDir, filePath)
-    .split(path.sep)
-    .join(path.posix.sep);
+  const rel = toPosix(path.relative(publicDir, filePath));
   if (contentAssetRelPaths && contentAssetRelPaths.has(rel)) {
     log.error`public/${B`${rel}`} conflicts with content/${B`${rel}`}`;
     throw new Error(`public/${rel} and content/${rel} have the same path`);
@@ -103,10 +101,7 @@ export function copyContentFile(
   filePath: string,
   publicRelPaths?: Set<string>,
 ): void {
-  const rel = path
-    .relative(contentDir, filePath)
-    .split(path.sep)
-    .join(path.posix.sep);
+  const rel = toPosix(path.relative(contentDir, filePath));
   if (publicRelPaths && publicRelPaths.has(rel)) {
     log.error`content/${B`${rel}`} conflicts with public/${B`${rel}`}`;
     throw new Error(`content/${rel} and public/${rel} have the same path`);

package/build/generate-content-assets.ts

@@ -16,6 +16,7 @@ import {
 } from './util';
 import { isLiterateJava } from './utils/file-types';
 import { checkJavac } from './utils/literate-java';
+import { toPosix } from './utils/paths';
 import type {
   SiteVariables,
   Asset,
@@ -291,10 +292,7 @@ export class ContentRenderer {
     for (const filePath of buildContentFiles) {
       if (isLiterateJava(filePath)) {
         const parsed = path.parse(path.relative(contentDir, filePath));
-        const javaPath = path
-          .join(parsed.dir, parsed.name)
-          .split(path.sep)
-          .join(path.posix.sep);
+        const javaPath = toPosix(path.join(parsed.dir, parsed.name));
         literateJavaOutputPaths.add(`/${javaPath}`);
       }
     }

package/build/utils/content-files.ts

@@ -7,7 +7,7 @@ import {
   isLiterateJava,
   isPartial,
 } from './file-types';
-import { getPublicDir, normalizeOutputPath } from './paths';
+import { getPublicDir, normalizeOutputPath, toPosix } from './paths';
 
 function walkFiles(dir: string): string[] {
   return fs.readdirSync(dir).flatMap(file => {
@@ -111,18 +111,12 @@ export function getValidInternalTargets(
     const relPath = path.relative(contentDir, filePath);
     const parsed = path.parse(relPath);
     const ext = parsed.ext.toLowerCase();
-    const subPath = path
-      .join(parsed.dir, parsed.name)
-      .split(path.sep)
-      .join(path.posix.sep);
+    const subPath = toPosix(path.join(parsed.dir, parsed.name));
 
     if (isLiterateJava(filePath)) {
       // parsed.name is e.g. "VowelCounter.java"; the output page is
       // VowelCounter.java.html and the source file is VowelCounter.java
-      const javaSubPath = path
-        .join(parsed.dir, parsed.name)
-        .split(path.sep)
-        .join(path.posix.sep);
+      const javaSubPath = toPosix(path.join(parsed.dir, parsed.name));
       addGeneratedRouteAliases(targets, `/${javaSubPath}.html`);
       targets.add(normalizeOutputPath(`/${javaSubPath}`));
     } else if (extensionIsMarkdown(ext) || ext === '.html') {

package/build/utils/paths.ts

@@ -45,8 +45,23 @@ export function createApplyBasePath(
   };
 }
 
+export function toPosix(p: string): string {
+  return p.split(path.sep).join(path.posix.sep);
+}
+
+/**
+ * Convert an OS-native relative filesystem path to a URL path: convert
+ * separators to '/', then percent-encode each segment so characters that
+ * are unsafe in URLs (space, ?, #, non-ASCII, etc.) are encoded. Use this
+ * anywhere a filesystem-derived path is emitted as an href or looked up
+ * against a URL-encoded href.
+ */
+export function toUrlPath(p: string): string {
+  return toPosix(p).split('/').map(encodeURIComponent).join('/');
+}
+
 export function normalizeOutputPath(outputPath: string): string {
-  const normalized = path.posix.normalize(outputPath);
+  const normalized = path.posix.normalize(toPosix(outputPath));
   if (normalized === '.' || normalized === '') {
     return '/';
   }

package/build/utils/render.ts

@@ -17,7 +17,12 @@ import {
 import { extensionIsMarkdown } from './file-types';
 import { createTraceHelpers } from './trace';
 import { createIncludeFunction } from './include';
-import { createApplyBasePath, normalizeOutputPath } from './paths';
+import {
+  createApplyBasePath,
+  normalizeOutputPath,
+  toPosix,
+  toUrlPath,
+} from './paths';
 import { parseFrontMatterAndContent } from './front-matter';
 import { createMarkdown } from './markdown';
 import { generateTocHtml, generateCodeTocHtml } from '../toc-plugin';
@@ -164,10 +169,7 @@ export function injectKatexStylesheet(
 }
 
 function toContentAssetPath(contentDir: string, filePath: string): string {
-  return path
-    .relative(contentDir, filePath)
-    .split(path.sep)
-    .join(path.posix.sep);
+  return toPosix(path.relative(contentDir, filePath));
 }
 
 export function renderPlainTextPageAsset({
@@ -182,7 +184,7 @@ export function renderPlainTextPageAsset({
   javacAvailable,
 }: RenderPlainTextOptions): Asset[] {
   const { dir, name, ext } = path.parse(filePath);
-  const subPath = path.relative(contentDir, path.join(dir, name));
+  const subPath = toPosix(path.relative(contentDir, path.join(dir, name)));
   const applyBasePath = createApplyBasePath(siteVariables);
 
   log.info`Rendering page ${B`${subPath + ext}`}`;
@@ -248,11 +250,11 @@ export function renderCodePageAsset({
   assetFiles,
 }: RenderCodePageOptions): Asset[] {
   const { dir, name, ext } = path.parse(filePath);
-  const subPath = path.relative(contentDir, path.join(dir, name));
+  const subPath = toPosix(path.relative(contentDir, path.join(dir, name)));
   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);
+  const pageDirPath = toPosix(path.relative(contentDir, dir));
 
   log.info`Rendering code page ${B`${subPath + ext}`}`;
   const content = renderCodeWithComments(
@@ -262,7 +264,7 @@ export function renderCodePageAsset({
     pageDirPath,
   );
   const codeFilePath = applyBasePath(
-    normalizeOutputPath(`/${toContentAssetPath(contentDir, filePath)}`),
+    normalizeOutputPath(`/${toUrlPath(path.relative(contentDir, filePath))}`),
   );
   const titleHtml = `<tt>${name + ext}</tt>`;
   const tocItems = lang === 'java' ? extractJavaMethodToc(sourceCode) : [];
@@ -316,7 +318,9 @@ export function renderCopiedContentAsset({
 
   if (filePath.endsWith('.java') && isFeatureEnabled(siteVariables, 'code')) {
     const sourceCode = fs.readFileSync(filePath, 'utf-8');
-    const pageDirPath = path.relative(contentDir, path.dirname(filePath));
+    const pageDirPath = toPosix(
+      path.relative(contentDir, path.dirname(filePath)),
+    );
     const rewrittenLines = rewriteProseLinks(
       sourceCode.split('\n'),
       siteVariables,
@@ -501,7 +505,7 @@ export function renderLiterateJavaPageAsset({
 }: RenderLiterateJavaOptions): Asset[] {
   const { dir, name } = path.parse(filePath);
   const className = deriveClassName(filePath);
-  const subPath = path.relative(contentDir, path.join(dir, className));
+  const subPath = toPosix(path.relative(contentDir, path.join(dir, className)));
   const applyBasePath = createApplyBasePath(siteVariables);
 
   log.info`Rendering literate Java page ${B`${name}`}`;
@@ -619,7 +623,7 @@ export function renderLiterateJavaPageAsset({
   const javaFileName = `${className}.java`;
   const codeFilePath = applyBasePath(
     normalizeOutputPath(
-      `/${toContentAssetPath(contentDir, path.join(dir, javaFileName))}`,
+      `/${toUrlPath(path.relative(contentDir, path.join(dir, javaFileName)))}`,
     ),
   );
 

package/build/utils/trace.ts

@@ -4,7 +4,7 @@ import path from 'path';
 import { execFileSync } from 'child_process';
 import { makeLogger } from '../log';
 import { B } from '../colors';
-import { normalizeOutputPath } from './paths';
+import { normalizeOutputPath, toPosix } from './paths';
 import { hasMainMethod } from './literate-java';
 import { renderCodeSegment } from './code';
 import { computeLayout } from './trace-layout';
@@ -324,10 +324,7 @@ export function createTraceHelpers(context: TraceContext): {
 
       const highlightedSource = highlightSource(javaFile, source);
 
-      const relDir = path
-        .relative(contentDir, pageDir)
-        .split(path.sep)
-        .join(path.posix.sep);
+      const relDir = toPosix(path.relative(contentDir, pageDir));
       const traceOutputDir = path.join(distDir, relDir, '_traces', className);
 
       const manifest = chunkTraceOutput(

package/build/validate-internal-links-plugin.ts

@@ -69,7 +69,18 @@ function resolveLinkPath(
     ? normalizePathname(hrefPath)
     : normalizePathname(path.posix.join(sourceDir, hrefPath));
 
-  return rewriteCodeLink(resolved, codeExtPattern);
+  // Decode percent-encoded characters so the resolved path can be matched
+  // against `validTargets`, which contains raw filesystem-derived paths.
+  // markdown-it's normalizeLink percent-encodes hrefs, so a link like
+  // `[x](/my notes.md)` arrives here as `/my%20notes.md`.
+  let decoded: string;
+  try {
+    decoded = normalizePathname(decodeURIComponent(resolved));
+  } catch {
+    decoded = resolved;
+  }
+
+  return rewriteCodeLink(decoded, codeExtPattern);
 }
 
 function getDirectoryIndexPath(pathname: string): string {

package/build/watch-reload-client.ts

@@ -26,6 +26,7 @@ declare const __WEBSOCKET_PORT__: number;
       document.body.classList.add('loading-cursor');
     } else if (event.data === 'reload') {
       console.log('[watch-reload] Reloading page...');
+      window.history.scrollRestoration = 'auto';
       window.location.reload();
     }
   };

package/build/watch.ts

@@ -12,6 +12,7 @@ import {
   getPublicDir,
   getDistDir,
   getPackageDir,
+  toPosix,
 } from './utils/paths';
 import { isFeatureEnabled } from './features';
 import { bundle } from './bundle';
@@ -55,10 +56,7 @@ export async function runWatch(options: {
       define: { __WEBSOCKET_PORT__: String(WEBSOCKET_PORT) },
     });
     return result.outputs.map(output =>
-      path
-        .relative(getDistDir(), output.path)
-        .split(path.sep)
-        .join(path.posix.sep),
+      toPosix(path.relative(getDistDir(), output.path)),
     );
   }
 
@@ -154,10 +152,7 @@ export async function runWatch(options: {
       return null;
     }
 
-    return path
-      .relative(contentDir, normalizedFilePath)
-      .split(path.sep)
-      .join(path.posix.sep);
+    return toPosix(path.relative(contentDir, normalizedFilePath));
   }
 
   function toPublicRelativePath(filePath: string): string | null {
@@ -169,10 +164,7 @@ export async function runWatch(options: {
     if (!normalizedFilePath.startsWith(normalizedPublicDir)) {
       return null;
     }
-    return path
-      .relative(publicDir, normalizedFilePath)
-      .split(path.sep)
-      .join(path.posix.sep);
+    return toPosix(path.relative(publicDir, normalizedFilePath));
   }
 
   // Watch mode
@@ -354,10 +346,7 @@ export async function runWatch(options: {
             const absPath = path.resolve(filePath);
             if (fs.existsSync(absPath)) {
               copyPublicFile(publicDir, distDir, absPath, contentAssetRelPaths);
-              const rel = path
-                .relative(publicDir, absPath)
-                .split(path.sep)
-                .join(path.posix.sep);
+              const rel = toPosix(path.relative(publicDir, absPath));
               publicRelPaths.add(rel);
             }
           }
@@ -397,10 +386,7 @@ export async function runWatch(options: {
             const absPath = path.resolve(filePath);
             if (fs.existsSync(absPath)) {
               copyPublicFile(publicDir, distDir, absPath, contentAssetRelPaths);
-              const rel = path
-                .relative(publicDir, absPath)
-                .split(path.sep)
-                .join(path.posix.sep);
+              const rel = toPosix(path.relative(publicDir, absPath));
               publicRelPaths.add(rel);
             }
           }
@@ -417,10 +403,7 @@ export async function runWatch(options: {
           const ext = path.extname(absPath).slice(1).toLowerCase();
           if (!processedExtSet.has(ext) && fs.existsSync(absPath)) {
             copyContentFile(contentDir, distDir, absPath, publicRelPaths);
-            const rel = path
-              .relative(contentDir, absPath)
-              .split(path.sep)
-              .join(path.posix.sep);
+            const rel = toPosix(path.relative(contentDir, absPath));
             contentAssetRelPaths.add(rel);
           }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abreen/tada",
-  "version": "1.5.7",
+  "version": "1.6.0",
   "type": "module",
   "description": "A static site generator",
   "license": "MIT",
@@ -29,10 +29,10 @@
     "prepack": "bun run scripts/prepack.ts",
     "lint": "eslint src/ build/ bin/",
     "typecheck": "tsc --noEmit",
-    "test:functional": "python3 -m pip install -q -r functional_tests/requirements.txt && python3 -m pytest functional_tests/ -v -n auto --durations=10",
-    "test:all": "bun test && bun run test:playwright && bun run test:functional",
-    "test:coverage": "rm -rf coverage/unit coverage/functional && bun test --coverage && TADA_COVERAGE=1 python3 -m pip install -q -r functional_tests/requirements.txt && TADA_COVERAGE=1 python3 -m pytest functional_tests/ -v -n auto --durations=10 && bun run scripts/coverage-report.ts",
-    "test:playwright": "bunx playwright test",
+    "test:functional": "bun run scripts/test.ts functional",
+    "test:all": "bun run scripts/test.ts all",
+    "test:coverage": "bun run scripts/test.ts coverage",
+    "test:playwright": "bun run scripts/test.ts playwright",
     "init-example": "bun run bin/tada.ts init example --no-interactive",
     "iew": "if [ -d example ]; then cd example; else bun run init-example && cd example; fi && ../bin/tada.ts watch"
   },
@@ -41,7 +41,8 @@
   },
   "os": [
     "darwin",
-    "linux"
+    "linux",
+    "win32"
   ],
   "dependencies": {
     "@vscode/markdown-it-katex": "^1.1.2",
@@ -77,7 +78,7 @@
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
-    "@playwright/test": "^1.59.1",
+    "@playwright/test": "1.56.1",
     "@saintedlama/lcov-parse": "^1.0.1",
     "@types/bun": "^1.3.10",
     "@types/culori": "^4.0.1",

package/src/style.scss

@@ -396,8 +396,8 @@ dl {
     }
   }
 
-  dd {
-    margin-bottom: var(--gap);
+  dd > *:first-child {
+    margin-top: 0;
   }
 }