@abreen/tada 1.5.0 → 1.5.2

package/build/markdown-plugins.test.ts

@@ -1,456 +0,0 @@
-import { describe, expect, test } from 'bun:test';
-import MarkdownIt from 'markdown-it';
-import deflist from 'markdown-it-deflist';
-import applyBasePathPlugin from './apply-base-path-plugin';
-import deflistIdPlugin from './deflist-id-plugin';
-import externalLinksPlugin from './external-links-plugin';
-import headingSubtitlePlugin from './heading-subtitle-plugin';
-import columnsPlugin from './columns-plugin';
-import { createMarkdown } from './utils/markdown';
-import { stripHtmlComments, injectKatexStylesheet } from './utils/render';
-import type { SiteVariables } from './types';
-
-describe('apply-base-path-plugin', () => {
-  test('rewrites internal links, images, and raw html sources', () => {
-    const md = new MarkdownIt({ html: true });
-    md.use(applyBasePathPlugin, {
-      basePath: '/course/',
-      codeLanguages: { java: 'java' },
-      features: { code: true },
-    });
-
-    const html = md.render(
-      [
-        '[Code](/src/example.java?view=1#top)',
-        '',
-        '![Image](/images/pic.png)',
-        '',
-        '<img src="/images/raw.png" alt="Raw">',
-        '',
-        '<a href="/about/">About</a>',
-      ].join('\n'),
-    );
-
-    expect(html).toContain('href="/course/src/example.java.html?view=1#top"');
-    expect(html).toContain('src="/course/images/pic.png"');
-    expect(html).toContain('src="/course/images/raw.png"');
-    expect(html).toContain('href="/course/about/"');
-  });
-
-  test('does not rewrite external or relative raw html links', () => {
-    const md = new MarkdownIt({ html: true });
-    md.use(applyBasePathPlugin, {
-      basePath: '/course/',
-      codeLanguages: {},
-      features: { code: true },
-    });
-
-    const html = md.render(
-      [
-        '<a href="https://example.com/">External</a>',
-        '',
-        '<a href="relative.html">Relative</a>',
-      ].join('\n'),
-    );
-
-    expect(html).toContain('href="https://example.com/"');
-    expect(html).toContain('href="relative.html"');
-  });
-
-  test('rewrites relative code file links without applying base path', () => {
-    const md = new MarkdownIt();
-    md.use(applyBasePathPlugin, {
-      basePath: '/course/',
-      codeLanguages: { java: 'java' },
-      features: { code: true },
-    });
-
-    const html = md.render('[App](./App.java)');
-
-    expect(html).toContain('href="./App.java.html"');
-    expect(html).not.toContain('href="./App.java"');
-  });
-
-  test('keeps code file extensions when the code feature is disabled', () => {
-    const md = new MarkdownIt();
-    md.use(applyBasePathPlugin, {
-      basePath: '/course',
-      codeLanguages: { java: 'java' },
-      features: { code: false },
-    });
-
-    const html = md.render('[Code](/src/example.java#L1)');
-
-    expect(html).toContain('href="/course/src/example.java#L1"');
-    expect(html).not.toContain('href="/course/src/example.html#L1"');
-  });
-});
-
-describe('external-links-plugin', () => {
-  test('marks external http links without changing internal or non-http links', () => {
-    const md = new MarkdownIt();
-    md.use(externalLinksPlugin, { internalDomains: ['example.com'] });
-
-    const html = md.render(
-      [
-        '[External](https://outside.example/docs)',
-        '[Internal](https://example.com/docs)',
-        '[Mail](mailto:test@example.com)',
-      ].join(' '),
-    );
-
-    expect(html).toContain(
-      '<a href="https://outside.example/docs" class="external" target="_blank">External</a>',
-    );
-    expect(html).toContain('<a href="https://example.com/docs">Internal</a>');
-    expect(html).toContain('<a href="mailto:test@example.com">Mail</a>');
-  });
-});
-
-describe('heading-subtitle-plugin', () => {
-  test('wraps heading subtitles while preserving inline formatting', () => {
-    const md = new MarkdownIt();
-    md.use(headingSubtitlePlugin);
-
-    const html = md.render('## Title # *Subtitle*').trim();
-
-    expect(html).toBe(
-      '<h2 class="has-subtitle">Title <span class="heading-subtitle"><em>Subtitle</em></span></h2>',
-    );
-  });
-});
-
-describe('deflist-id-plugin', () => {
-  test('injects unique ids for terms and falls back when a term slug is empty', () => {
-    const md = new MarkdownIt();
-    md.use(deflist);
-    md.use(deflistIdPlugin);
-
-    const html = md.render(
-      ['Term 1', ': One', '', 'Term 1', ': Two', '', '!!!', ': Three'].join(
-        '\n',
-      ),
-    );
-
-    expect(html).toContain('<a id="term-1"></a>Term 1');
-    expect(html).toContain('<a id="term-1-2"></a>Term 1');
-    expect(html).toContain('<a id="term"></a>!!!');
-  });
-});
-
-describe('custom markdown containers', () => {
-  function createProjectMarkdown() {
-    return createMarkdown(
-      {
-        base: '',
-        basePath: '/',
-        internalDomains: [],
-        codeLanguages: {},
-        features: { search: true, code: true, favicon: false },
-        title: 'Test',
-        titlePostfix: ' - Test',
-        themeColor: 'steelblue',
-        defaultTimeZone: 'America/New_York',
-      } as SiteVariables,
-      { validatorOptions: { enabled: false } },
-    );
-  }
-
-  test('renders collapsible details blocks', () => {
-    const md = createProjectMarkdown();
-
-    const html = md.render(
-      ['<<< details More info', 'Hello', '<<<'].join('\n'),
-    );
-
-    expect(html).toContain('<details><summary>More info</summary>');
-    expect(html).toContain('<div class="content">');
-    expect(html).toContain('<p>Hello</p>');
-    expect(html).toContain('</div></details>');
-  });
-
-  test('renders collapsible details blocks with inline Markdown in summary', () => {
-    const md = createProjectMarkdown();
-
-    const html = md.render(
-      ['<<< details More **info**', 'Hello', '<<<'].join('\n'),
-    );
-
-    expect(html).toContain(
-      '<details><summary>More <strong>info</strong></summary>',
-    );
-  });
-
-  test('renders section containers as section elements', () => {
-    const md = createProjectMarkdown();
-
-    const html = md.render(['::: section', 'Body', ':::'].join('\n'));
-
-    expect(html).toContain('<section>');
-    expect(html).toContain('<p>Body</p>');
-    expect(html).toContain('</section>');
-  });
-
-  test('renders questions with question and spoiler answer', () => {
-    const md = createProjectMarkdown();
-
-    const html = md.render(
-      [
-        '??? question What is a data structure?',
-        'An organized collection.',
-        '???',
-      ].join('\n'),
-    );
-
-    expect(html).toContain('<div class="question">');
-    expect(html).toContain(
-      '<p class="question-q"><span class="question-label">Q.</span><span>What is a data structure?</span></p>',
-    );
-    expect(html).toContain('<p class="question-a-label">A.</p>');
-    expect(html).toContain(
-      '<div class="question-a-body" data-pagefind-ignore>',
-    );
-    expect(html).toContain('<p>An organized collection.</p>');
-  });
-
-  test('renders alert containers with custom and default titles', () => {
-    const md = createProjectMarkdown();
-
-    const html = md.render(
-      [
-        '!!! note "Read this"',
-        'Body',
-        '!!!',
-        '',
-        '!!! warning',
-        'Careful',
-        '!!!',
-      ].join('\n'),
-    );
-
-    expect(html).toContain('<div class="alert note">');
-    expect(html).toContain('<p class="title" id="read-this">');
-    expect(html).toContain(
-      '<div class="alert warning"><p class="title" id="warning">Warning</p>',
-    );
-    expect(html).toContain('<p>Body</p>');
-    expect(html).toContain('<p>Careful</p>');
-  });
-
-  test('deduplicates alert IDs', () => {
-    const md = createProjectMarkdown();
-
-    const html = md.render(
-      [
-        '!!! note',
-        'First',
-        '!!!',
-        '',
-        '!!! note',
-        'Second',
-        '!!!',
-        '',
-        '!!! note "Custom"',
-        'Third',
-        '!!!',
-        '',
-        '!!! note "Custom"',
-        'Fourth',
-        '!!!',
-      ].join('\n'),
-    );
-
-    expect(html).toContain('<p class="title" id="note">Note</p>');
-    expect(html).toContain('<p class="title" id="note-2">Note</p>');
-    expect(html).toContain('id="custom"');
-    expect(html).toContain('id="custom-2"');
-  });
-});
-
-describe('hidden_fence rule', () => {
-  function createProjectMarkdown() {
-    return createMarkdown(
-      {
-        base: '',
-        basePath: '/',
-        internalDomains: [],
-        codeLanguages: {},
-        features: { search: true, code: true, favicon: false },
-        title: 'Test',
-        titlePostfix: ' - Test',
-        themeColor: 'steelblue',
-        defaultTimeZone: 'America/New_York',
-      } as SiteVariables,
-      { validatorOptions: { enabled: false } },
-    );
-  }
-
-  test('removes triple-hyphen comments containing a code fence', () => {
-    const md = createProjectMarkdown();
-
-    const html = md.render(
-      ['<!---', '```', 'import java.util.*;', '```', '-->'].join('\n'),
-    );
-
-    expect(html).not.toContain('<!---');
-    expect(html).not.toContain('import java.util');
-  });
-
-  test('does not remove triple-hyphen comments without a code fence', () => {
-    const md = createProjectMarkdown();
-
-    const html = md.render(
-      ['<!---', 'This is a plain comment.', '-->'].join('\n'),
-    );
-
-    // markdown-it passes through html_block tokens unchanged;
-    // the hidden_fence rule only converts comments that contain fences
-    expect(html).toContain('<!---');
-  });
-
-  test('preserves double-hyphen HTML comments', () => {
-    const md = createProjectMarkdown();
-
-    const html = md.render(['<!-- standard HTML comment -->'].join('\n'));
-
-    expect(html).toContain('<!-- standard HTML comment -->');
-  });
-});
-
-describe('stripHtmlComments', () => {
-  test('removes a single triple-hyphen comment', () => {
-    const result = stripHtmlComments(
-      '<p>Before</p>\n<!--- hidden comment -->\n<p>After</p>',
-    );
-    expect(result).toBe('<p>Before</p>\n\n<p>After</p>');
-  });
-
-  test('removes multiple triple-hyphen comments', () => {
-    const result = stripHtmlComments('<!--- first -->\ntext\n<!--- second -->');
-    expect(result).toBe('\ntext\n');
-  });
-
-  test('removes triple-hyphen comments spanning multiple lines', () => {
-    const result = stripHtmlComments(
-      '<p>Keep</p>\n<!---\nLine 1\nLine 2\n-->\n<p>Also keep</p>',
-    );
-    expect(result).toBe('<p>Keep</p>\n\n<p>Also keep</p>');
-  });
-
-  test('does not remove double-hyphen HTML comments', () => {
-    const input = '<p>Before</p>\n<!-- keep this -->\n<p>After</p>';
-    expect(stripHtmlComments(input)).toBe(input);
-  });
-
-  test('returns input unchanged when there are no comments', () => {
-    const input = '<p>Hello world</p>';
-    expect(stripHtmlComments(input)).toBe(input);
-  });
-});
-
-describe('katex plugin', () => {
-  function createProjectMarkdown() {
-    return createMarkdown(
-      {
-        base: '',
-        basePath: '/',
-        internalDomains: [],
-        codeLanguages: {},
-        features: { search: true, code: true, favicon: false },
-        title: 'Test',
-        titlePostfix: ' - Test',
-        themeColor: 'steelblue',
-        defaultTimeZone: 'America/New_York',
-      } as SiteVariables,
-      { validatorOptions: { enabled: false } },
-    );
-  }
-
-  test('renders inline math with $ delimiters', () => {
-    const md = createProjectMarkdown();
-    const html = md.render('The equation $E = mc^2$ is famous.');
-    expect(html).toContain('class="katex"');
-    expect(html).toContain('mc');
-  });
-
-  test('renders display math with $$ delimiters', () => {
-    const md = createProjectMarkdown();
-    const html = md.render('$$\\sum_{i=1}^{n} i = \\frac{n(n+1)}{2}$$');
-    expect(html).toContain('class="katex-display"');
-  });
-
-  test('includes aria-label for inline math', () => {
-    const md = createProjectMarkdown();
-    const html = md.render('$E = mc^2$');
-    expect(html).toContain('aria-label="E, equals, m, c, squared"');
-  });
-
-  test('includes aria-label for display math', () => {
-    const md = createProjectMarkdown();
-    const html = md.render('$$\\frac{1}{2}$$');
-    expect(html).toContain(
-      'aria-label="start fraction, 1, divided by, 2, end fraction"',
-    );
-  });
-
-  test('throws on invalid LaTeX syntax', () => {
-    const md = createProjectMarkdown();
-    expect(() => md.render('$\\invalidcommand{$')).toThrow();
-  });
-
-  test('does not produce katex output when no math delimiters are used', () => {
-    const md = createProjectMarkdown();
-    const html = md.render('Just a normal paragraph with a $5 price tag.');
-    expect(html).not.toContain('class="katex"');
-  });
-});
-
-describe('columns plugin', () => {
-  const md = new MarkdownIt().use(columnsPlugin);
-
-  test('basic two-column layout', () => {
-    const html = md.render('+++\nCol 1\n+++\nCol 2\n+++\n');
-    expect(html).toContain('<div class="columns">');
-    expect(html).toContain('<p>Col 1</p>');
-    expect(html).toContain('<p>Col 2</p>');
-    // Two column divs inside the wrapper
-    expect(html).toMatch(
-      /<div class="columns">\n<div>\n.*<\/div>\n<div>\n.*<\/div>\n<\/div>/s,
-    );
-  });
-
-  test('rich markdown inside columns', () => {
-    const html = md.render('+++\n## Heading\n- item\n+++\nA paragraph.\n+++\n');
-    expect(html).toContain('<h2>Heading</h2>');
-    expect(html).toContain('<li>');
-    expect(html).toContain('<p>A paragraph.</p>');
-  });
-
-  test('incomplete block with only two fences is not matched', () => {
-    const html = md.render('+++\nContent\n+++\n');
-    expect(html).not.toContain('<div class="columns">');
-  });
-
-  test('empty columns produce no content errors', () => {
-    const html = md.render('+++\n+++\n+++\n');
-    expect(html).toContain('<div class="columns">');
-  });
-});
-
-describe('injectKatexStylesheet', () => {
-  test('injects deferred KaTeX stylesheet link into <head>', () => {
-    const html =
-      '<html><head><meta charset="UTF-8"></head><body></body></html>';
-    const result = injectKatexStylesheet(html, p => p);
-
-    expect(result).toContain('href="/katex/katex.min.css"');
-    expect(result).toContain('rel="stylesheet"');
-  });
-
-  test('applies basePath to the stylesheet URL', () => {
-    const html = '<html><head></head><body></body></html>';
-    const result = injectKatexStylesheet(html, p => '/course' + p);
-
-    expect(result).toContain('href="/course/katex/katex.min.css"');
-  });
-});

package/build/pagefind.test.ts

@@ -1,192 +0,0 @@
-import path from 'path';
-import { describe, expect, test } from 'bun:test';
-import { buildIndex, collectIndexTargets } from './pagefind';
-import type { SiteVariables } from './types';
-
-interface FakePagefindCalls {
-  htmlFiles?: { sourcePath: string; content: string }[];
-  customRecords?: {
-    url: string;
-    content: string;
-    language: string;
-    meta: Record<string, string>;
-  }[];
-  outputPath?: string | null;
-  deleted?: number;
-}
-
-function createFakePagefind(calls: FakePagefindCalls) {
-  const fakeIndex = {
-    addHTMLFile: async (file: { sourcePath: string; content: string }) => {
-      calls.htmlFiles?.push(file);
-      return { errors: [], file: { url: file.sourcePath, meta: {} } };
-    },
-    addCustomRecord: async (record: {
-      url: string;
-      content: string;
-      language: string;
-      meta: Record<string, string>;
-    }) => {
-      calls.customRecords?.push(record);
-      return { errors: [], file: { url: record.url, meta: record.meta } };
-    },
-    writeFiles: async ({ outputPath }: { outputPath: string }) => {
-      calls.outputPath = outputPath;
-      return { errors: [], outputPath };
-    },
-    deleteIndex: async () => {
-      calls.deleted = (calls.deleted || 0) + 1;
-    },
-  };
-
-  return (() =>
-    Promise.resolve({
-      createIndex: async () => ({ index: fakeIndex, errors: [] }),
-    })) as unknown as () => Promise<typeof import('pagefind')>;
-}
-
-describe('PagefindPlugin', () => {
-  test('collectIndexTargets only includes linked PDFs from reachable HTML pages', () => {
-    const htmlAssetsByPath = new Map([
-      [
-        'index.html',
-        '<a href="/about/">About</a><a href="/docs/guide.pdf">Guide</a>',
-      ],
-      ['about/index.html', '<p>About</p>'],
-      ['orphan/index.html', '<p>Orphan</p>'],
-    ]);
-    const pdfSourceByOutputPath = new Map([
-      ['/docs/guide.pdf', '/tmp/docs/guide.pdf'],
-      ['/docs/orphan.pdf', '/tmp/docs/orphan.pdf'],
-    ]);
-
-    const result = collectIndexTargets(
-      htmlAssetsByPath,
-      { base: '', basePath: '/' } as SiteVariables,
-      pdfSourceByOutputPath,
-    );
-
-    expect(result).toEqual({
-      reachableHtmlPaths: ['about/index.html', 'index.html'],
-      reachablePdfPaths: ['/docs/guide.pdf'],
-    });
-  });
-
-  test('buildIndex adds HTML files and per-page PDF custom records', async () => {
-    const calls: FakePagefindCalls = {
-      htmlFiles: [],
-      customRecords: [],
-      outputPath: null,
-    };
-
-    await buildIndex({
-      distPath: '/tmp/dist',
-      htmlAssetsByPath: new Map([
-        ['index.html', '<html><body>Home</body></html>'],
-        ['about/index.html', '<html><body>About</body></html>'],
-      ]),
-      reachableHtmlPaths: ['index.html', 'about/index.html'],
-      reachablePdfPaths: ['/docs/guide.pdf'],
-      pdfSourceByOutputPath: new Map([
-        ['/docs/guide.pdf', '/tmp/docs/guide.pdf'],
-      ]),
-      loadPagefind: createFakePagefind(calls),
-      checkMutool: async () => {},
-      extractPages: async filePath => ({
-        pages: [
-          { pageNumber: 2, content: `EXTRACTED:${path.basename(filePath)}:2` },
-          { pageNumber: 5, content: `EXTRACTED:${path.basename(filePath)}:5` },
-        ],
-        hasExtractedText: true,
-      }),
-    });
-
-    expect(calls.htmlFiles).toEqual([
-      { sourcePath: 'index.html', content: '<html><body>Home</body></html>' },
-      {
-        sourcePath: 'about/index.html',
-        content: '<html><body>About</body></html>',
-      },
-    ]);
-    expect(calls.customRecords).toEqual([
-      {
-        url: '/docs/guide.pdf#page=2',
-        content: 'EXTRACTED:guide.pdf:2',
-        language: 'en',
-        meta: { title: 'guide.pdf', page: '2' },
-      },
-      {
-        url: '/docs/guide.pdf#page=5',
-        content: 'EXTRACTED:guide.pdf:5',
-        language: 'en',
-        meta: { title: 'guide.pdf', page: '5' },
-      },
-    ]);
-    expect(calls.outputPath).toBe('/tmp/dist/pagefind');
-    expect(calls.deleted).toBe(1);
-  });
-
-  test('buildIndex prepends filename to page 1 content for searchability', async () => {
-    const calls: FakePagefindCalls = { htmlFiles: [], customRecords: [] };
-
-    await buildIndex({
-      distPath: '/tmp/dist',
-      htmlAssetsByPath: new Map(),
-      reachableHtmlPaths: [],
-      reachablePdfPaths: ['/docs/lecture1.pdf'],
-      pdfSourceByOutputPath: new Map([
-        ['/docs/lecture1.pdf', '/tmp/docs/lecture1.pdf'],
-      ]),
-      loadPagefind: createFakePagefind(calls),
-      checkMutool: async () => {},
-      extractPages: async () => ({
-        pages: [
-          { pageNumber: 1, content: 'Welcome to the course' },
-          { pageNumber: 2, content: 'Chapter one' },
-        ],
-        hasExtractedText: true,
-      }),
-    });
-
-    expect(calls.customRecords).toEqual([
-      {
-        url: '/docs/lecture1.pdf#page=1',
-        content: 'lecture1.pdf Welcome to the course',
-        language: 'en',
-        meta: { title: 'lecture1.pdf', page: '1' },
-      },
-      {
-        url: '/docs/lecture1.pdf#page=2',
-        content: 'Chapter one',
-        language: 'en',
-        meta: { title: 'lecture1.pdf', page: '2' },
-      },
-    ]);
-  });
-
-  test('buildIndex falls back to a single PDF record when text extraction is empty', async () => {
-    const calls: FakePagefindCalls = { customRecords: [] };
-
-    await buildIndex({
-      distPath: '/tmp/dist',
-      htmlAssetsByPath: new Map(),
-      reachableHtmlPaths: [],
-      reachablePdfPaths: ['/docs/guide.pdf'],
-      pdfSourceByOutputPath: new Map([
-        ['/docs/guide.pdf', '/tmp/docs/guide.pdf'],
-      ]),
-      loadPagefind: createFakePagefind(calls),
-      checkMutool: async () => {},
-      extractPages: async () => ({ pages: [], hasExtractedText: false }),
-    });
-
-    expect(calls.customRecords).toEqual([
-      {
-        url: '/docs/guide.pdf',
-        content: 'guide.pdf',
-        language: 'en',
-        meta: { title: 'guide.pdf' },
-      },
-    ]);
-  });
-});

package/build/pdf-text.test.ts

@@ -1,52 +0,0 @@
-import { describe, expect, test } from 'bun:test';
-import { buildPdfPageRecords } from './pdf-text';
-
-describe('buildPdfPageRecords', () => {
-  test('creates page records with 1-based page numbers', () => {
-    const result = buildPdfPageRecords(['Hello world', 'Second page']);
-    expect(result).toEqual({
-      pages: [
-        { pageNumber: 1, content: 'Hello world' },
-        { pageNumber: 2, content: 'Second page' },
-      ],
-      hasExtractedText: true,
-    });
-  });
-
-  test('normalizes whitespace in extracted text', () => {
-    const result = buildPdfPageRecords(['  lots   of\n\tspaces  ']);
-    expect(result).toEqual({
-      pages: [{ pageNumber: 1, content: 'lots of spaces' }],
-      hasExtractedText: true,
-    });
-  });
-
-  test('skips blank pages', () => {
-    const result = buildPdfPageRecords(['Page one', '', '   ', 'Page four']);
-    expect(result).toEqual({
-      pages: [
-        { pageNumber: 1, content: 'Page one' },
-        { pageNumber: 4, content: 'Page four' },
-      ],
-      hasExtractedText: true,
-    });
-  });
-
-  test('returns hasExtractedText false when all pages are blank', () => {
-    const result = buildPdfPageRecords(['', '   ', '\n\t']);
-    expect(result).toEqual({ pages: [], hasExtractedText: false });
-  });
-
-  test('returns hasExtractedText false for empty input', () => {
-    const result = buildPdfPageRecords([]);
-    expect(result).toEqual({ pages: [], hasExtractedText: false });
-  });
-
-  test('handles a single page', () => {
-    const result = buildPdfPageRecords(['Only page']);
-    expect(result).toEqual({
-      pages: [{ pageNumber: 1, content: 'Only page' }],
-      hasExtractedText: true,
-    });
-  });
-});