Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

4.6 KB
Raw Blame
import { describe, expect, test } from 'vitest';
import { findHubCandidates, findMissingDocCandidates } from './hub-candidates.ts';

function makeIndex(docNames: string[]): ReadonlyMap<string, unknown> {
  return new Map(docNames.map((name) => [name, { mtime: 0 }]));
}

describe('findHubCandidates', () => {
  test('finds a sibling INDEX.md', () => {
    const index = makeIndex(['reports/r1/INDEX', 'reports/r1/foo', 'reports/r1/bar']);
    expect(findHubCandidates('reports/r1/foo', index)).toEqual(['reports/r1/INDEX']);
  });

  test('finds folder-name-match as hub', () => {
    const index = makeIndex(['reports/r1/r1', 'reports/r1/evidence']);
    expect(findHubCandidates('reports/r1/evidence', index)).toEqual(['reports/r1/r1']);
  });

  test('walks upward when no hub in immediate folder', () => {
    const index = makeIndex(['reports/r1/evidence/a', 'reports/r1/evidence/b', 'reports/r1/INDEX']);
    expect(findHubCandidates('reports/r1/evidence/a', index)).toEqual(['reports/r1/INDEX']);
  });

  test('prefers nearest hub over ancestor hub', () => {
    const index = makeIndex([
      'reports/r1/INDEX',
      'reports/r1/evidence/REPORT',
      'reports/r1/evidence/a',
    ]);
    const result = findHubCandidates('reports/r1/evidence/a', index);
    expect(result[0]).toBe('reports/r1/evidence/REPORT');
    expect(result).toContain('reports/r1/INDEX');
  });

  test('caps at 3 candidates', () => {
    const index = makeIndex([
      'reports/r1/INDEX',
      'reports/r1/README',
      'reports/r1/REPORT',
      'reports/r1/SPEC',
      'reports/r1/r1',
      'reports/r1/foo',
    ]);
    const result = findHubCandidates('reports/r1/foo', index);
    expect(result.length).toBe(3);
    expect(result).toEqual(['reports/r1/INDEX', 'reports/r1/README', 'reports/r1/REPORT']);
  });

  test('matches case-insensitively on hub basenames', () => {
    const index = makeIndex(['reports/r1/readme', 'reports/r1/foo']);
    expect(findHubCandidates('reports/r1/foo', index)).toEqual(['reports/r1/readme']);
  });

  test('returns empty when no hub exists anywhere', () => {
    const index = makeIndex(['reports/r1/foo', 'reports/r1/bar']);
    expect(findHubCandidates('reports/r1/foo', index)).toEqual([]);
  });

  test('excludes the target doc itself', () => {
    const index = makeIndex(['reports/r1/INDEX']);
    expect(findHubCandidates('reports/r1/INDEX', index)).toEqual([]);
  });

  test('finds root-level README for a doc at root', () => {
    const index = makeIndex(['README', 'foo']);
    expect(findHubCandidates('foo', index)).toEqual(['README']);
  });

  test('finds root-level README for a deep doc after walking up', () => {
    const index = makeIndex(['README', 'a/b/c/d']);
    expect(findHubCandidates('a/b/c/d', index)).toEqual(['README']);
  });

  test('no folder-name-match at content root (empty folder has no basename)', () => {
    const index = makeIndex(['foo', 'bar']);
    expect(findHubCandidates('foo', index)).toEqual([]);
  });
});

describe('findMissingDocCandidates', () => {
  test('suggests the hub doc when the missing name is a folder', () => {
    const index = makeIndex(['reports/foo/REPORT', 'reports/foo/evidence']);
    expect(findMissingDocCandidates('reports/foo', index)).toEqual(['reports/foo/REPORT']);
  });

  test('suggests a folder-name-match hub', () => {
    const index = makeIndex(['guides/setup/setup', 'guides/setup/extra']);
    expect(findMissingDocCandidates('guides/setup', index)).toEqual(['guides/setup/setup']);
  });

  test('suggests documents whose trailing segments match a bundle-relative path', () => {
    const index = makeIndex([
      'kb/system/ways-of-working/operations',
      'archive/kb/system/ways-of-working/operations',
      'kb/system/ways-of-working/other',
    ]);
    expect(findMissingDocCandidates('system/ways-of-working/operations', index)).toEqual([
      'kb/system/ways-of-working/operations',
      'archive/kb/system/ways-of-working/operations',
    ]);
  });

  test('matches trailing segments whole, not as a substring of a segment', () => {
    const index = makeIndex(['wiki/my-operations', 'wiki/operations']);
    expect(findMissingDocCandidates('operations', index)).toEqual(['wiki/operations']);
  });

  test('lists hubs before trailing-segment matches and caps at 3', () => {
    const index = makeIndex(['notes/INDEX', 'notes/README', 'a/notes', 'b/notes']);
    expect(findMissingDocCandidates('notes', index)).toEqual([
      'notes/INDEX',
      'notes/README',
      'a/notes',
    ]);
  });

  test('returns empty when nothing resembles the missing name', () => {
    const index = makeIndex(['wiki/real']);
    expect(findMissingDocCandidates('wiki/zz-probe', index)).toEqual([]);
  });
});