Skip to content

armgit / cindy

Public Imported from GitHub
0

Consider it done. The open-source AI agent that works out of the box · 想到,就能做到。开源、开箱即用的 AI Agent。

13.7 KB
Raw Blame
/**
 * remarkLocalPathLinks.test.ts
 * ---------------------------------------------------------------------------
 * 单元测试:确保 remarkLocalPathLinks 能把正文纯文本里"带分隔符、可解析形状"
 * 的路径 token 切成 link 节点,同时不误吞普通词 / URL / 裸文件名,也不碰已经在
 * link 里的文本。
 *
 * 插件是 unified plugin,接收 mdast 树并原地修改。测试直接构造 AST 调用插件
 * 函数,避免依赖 `remark` 解析器(项目未显式安装),与 remarkTruncateCjkUrls
 * 的测试方式一致。
 */

import { describe, it, expect } from 'vitest';
import type { Root, Link, Text, Paragraph, PhrasingContent } from 'mdast';
import remarkLocalPathLinks from '../components/chat/remarkLocalPathLinks';

const transform = (remarkLocalPathLinks as () => (tree: Root) => void)();

/** 一个 paragraph 里放一段纯文本。 */
function textTree(value: string): Root {
  const text: Text = { type: 'text', value };
  const para: Paragraph = { type: 'paragraph', children: [text] };
  return { type: 'root', children: [para] };
}

function runOnText(value: string): PhrasingContent[] {
  const tree = textTree(value);
  transform(tree);
  return (tree.children[0] as Paragraph).children;
}

/** 抽出被切成 link 的 url 列表,方便断言"哪些 token 变成了链接"。 */
function linkUrls(children: PhrasingContent[]): string[] {
  return children.filter((c): c is Link => c.type === 'link').map((l) => l.url);
}

describe('remarkLocalPathLinks', () => {
  // ── 应该 linkify 的场景 ──

  it('正文里的相对路径(带分隔符 + 扩展名)', () => {
    const out = runOnText('见 src/App.tsx 第 20 行');
    expect(linkUrls(out)).toEqual(['src/App.tsx']);
    // 前后纯文本保留,路径只切出中间那段。
    expect((out[0] as Text).value).toBe('见 ');
    expect((out[2] as Text).value).toBe(' 第 20 行');
  });

  it('深层相对路径', () => {
    const out = runOnText('改的是 apps/desktop/src/main/pathResolver.ts 这个文件');
    expect(linkUrls(out)).toEqual(['apps/desktop/src/main/pathResolver.ts']);
  });

  it('Windows 绝对路径', () => {
    const out = runOnText('文件在 C:\\Users\\me\\proj\\app.tsx 里');
    expect(linkUrls(out)).toEqual(['C:\\Users\\me\\proj\\app.tsx']);
  });

  it('POSIX 绝对路径', () => {
    const out = runOnText('路径 /Users/me/proj/app.tsx 打开看看');
    expect(linkUrls(out)).toEqual(['/Users/me/proj/app.tsx']);
  });

  it('带 :line 行号后缀整体进 url,渲染层再拆', () => {
    const out = runOnText('见 src/App.tsx:42 那行');
    expect(linkUrls(out)).toEqual(['src/App.tsx:42']);
  });

  it('一段里多个路径都切出来', () => {
    const out = runOnText('对比 src/a.ts 和 src/b.ts');
    expect(linkUrls(out)).toEqual(['src/a.ts', 'src/b.ts']);
  });

  it('剥两侧包裹标点:括号 / 句末逗号', () => {
    expect(linkUrls(runOnText('(见 src/App.tsx)'))).toEqual(['src/App.tsx']);
    expect(linkUrls(runOnText('改了 src/App.tsx,然后呢'))).toEqual(['src/App.tsx']);
    expect(linkUrls(runOnText('文件:src/App.tsx。完'))).toEqual(['src/App.tsx']);
  });

  it('含 CJK 目录名的相对路径', () => {
    const out = runOnText('在 docs/设计稿/index.md 里');
    expect(linkUrls(out)).toEqual(['docs/设计稿/index.md']);
  });

  it('./ ../ 锚点的相对路径(单层也认;`~/` 见下条,刻意不认)', () => {
    expect(linkUrls(runOnText('打开 ./foo.md 看'))).toEqual(['./foo.md']);
    expect(linkUrls(runOnText('在 ../sib/foo.json 里'))).toEqual(['../sib/foo.json']);
  });

  it('前面是 ASCII 冒号也认(文件:src/x.ts)', () => {
    expect(linkUrls(runOnText('文件:src/App.tsx。完'))).toEqual(['src/App.tsx']);
  });

  // ── 不应该 linkify 的场景 ──

  it('裸文件名(无分隔符)不动——正文里太歧义', () => {
    const out = runOnText('改一下 package.json 配置');
    expect(linkUrls(out)).toEqual([]);
  });

  it('普通带斜杠的词不动:and/or、读写比', () => {
    expect(linkUrls(runOnText('支持 and/or 两种'))).toEqual([]);
    expect(linkUrls(runOnText('读/写 比例'))).toEqual([]);
  });

  it('URL 不动(裸文本形态,无扩展名结尾且带 scheme)', () => {
    expect(linkUrls(runOnText('看 https://example.com/path/page 这个'))).toEqual([]);
  });

  it('目录(尾部分隔符)不动', () => {
    expect(linkUrls(runOnText('放在 src/components/ 下'))).toEqual([]);
  });

  it('`~/` 不动 —— 本仓任何一层都不展开 `~`', () => {
    // resolveLocalPath 只做 join,main 侧 file-browser 也没有 homedir 展开 →
    // `~/logs/app.log` 会解析成 `<cwd>/~/logs/app.log`。本机会话因存在性检查退回纯
    // 文本,远程会话断链时会按「绝对形状」乐观点亮、点开错误地址(review 实捉)。
    expect(linkUrls(runOnText('日志在 ~/logs/app.log'))).toEqual([]);
    // 只删锚点里的 `~` 不够:SEG 含 `~`,`(?:SEG SEP)+` 一样能吃下 `~/`。
    expect(linkUrls(runOnText('见 ~/a/b.ts 与 ~/c.md'))).toEqual([]);
    // `~` 的中段用途不受影响。
    expect(linkUrls(runOnText('见 docs/a~1/b.ts'))).toEqual(['docs/a~1/b.ts']);
    expect(linkUrls(runOnText('见 src/old~.ts'))).toEqual(['src/old~.ts']);
  });

  it('未支持字符出现在**首个分隔符之前**时同样不动(白名单判据)', () => {
    // 上一版黑名单假设未支持字符在首个分隔符之后,括号在第一个 `/` 之前就绕过去了,
    // 还切出个绝对路径(review 实捉)。
    expect(linkUrls(runOnText('见 foo(bar)/src/index.ts'))).toEqual([]);
    expect(linkUrls(runOnText('见 foo#bar/src/index.ts'))).toEqual([]);
    expect(linkUrls(runOnText('见 a%b/c.ts'))).toEqual([]);
    // 白名单里的字符仍放行。
    expect(linkUrls(runOnText('见(src/a.ts)'))).toEqual(['src/a.ts']);
    expect(linkUrls(runOnText('文件:src/App.tsx。完'))).toEqual(['src/App.tsx']);
    expect(linkUrls(runOnText('跑 --config=src/a.json'))).toEqual([]);
  });

  it('复合标点后的行号后缀截断同样拒绝', () => {
    expect(linkUrls(runOnText('见 src/a.ts:12.5'))).toEqual([]);
    expect(linkUrls(runOnText('见 src/a.ts:12:foo'))).toEqual([]);
    // 连续 / 混合标点不得绕过(只看紧邻一个字符时会放行)。
    expect(linkUrls(runOnText('见 src/a.ts:12..5'))).toEqual([]);
    expect(linkUrls(runOnText('见 src/a.ts:12::foo'))).toEqual([]);
    expect(linkUrls(runOnText('见 src/a.ts:12:.:foo'))).toEqual([]);
    expect(linkUrls(runOnText('见 src/a.ts...'))).toEqual(['src/a.ts']);
    expect(linkUrls(runOnText('见 src/a.ts.'))).toEqual(['src/a.ts']);
    expect(linkUrls(runOnText('见 src/a.ts:'))).toEqual(['src/a.ts']);
  });

  it('未支持字符把 token 断开时,不从中段起匹配', () => {
    // `( ) # %` 不在 SEG 里,会断开一条真实路径,而左边界不挡它们(review 实捉)。
    // 判据是「同一 run 内已出现分隔符」,这类字符不需要逐个枚举。
    expect(linkUrls(runOnText('见 packages/foo(bar)/src/index.ts'))).toEqual([]);
    expect(linkUrls(runOnText('见 docs/50%off/a.md'))).toEqual([]);
    expect(linkUrls(runOnText('见 docs/a#b/c.md'))).toEqual([]);
    // 列表分隔符后允许重启;括号包裹整条路径照常识别。
    expect(linkUrls(runOnText('改了 src/a.ts,src/b.ts'))).toEqual(['src/a.ts', 'src/b.ts']);
    expect(linkUrls(runOnText('见(src/a.ts)'))).toEqual(['src/a.ts']);
  });

  it('行号后缀被截断时整条拒绝,不留错误行号', () => {
    // 正则的右边界只管到扩展名,整段 LINE_SUFFIX 之后没有边界(review 实捉)。
    expect(linkUrls(runOnText('见 src/a.ts:12345678'))).toEqual([]);
    expect(linkUrls(runOnText('见 src/a.ts:12foo'))).toEqual([]);
    // 合法行号照常;`:` 不进右边界,句末冒号不判废整条路径。
    expect(linkUrls(runOnText('见 src/a.png:12 行'))).toEqual(['src/a.png:12']);
    expect(linkUrls(runOnText('见 src/a.ts:'))).toEqual(['src/a.ts']);
  });

  it('含空格路径的中段不动 —— 切出的后缀是错误目标', () => {
    // 左边界不挡空格,正则会从空格后重新起匹配(review 实捉)。
    expect(linkUrls(runOnText('日志在 C:\\Program Files\\Cindy\\app.log'))).toEqual([]);
    expect(linkUrls(runOnText('见 /Users/me/My Folder/a.txt'))).toEqual([]);
    // 「前片段不以扩展名收尾」不能省:空格相邻的两条真路径必须都保住。
    expect(linkUrls(runOnText('修改了 src/a.ts src/b.ts'))).toEqual(['src/a.ts', 'src/b.ts']);
    expect(linkUrls(runOnText('解包 dist/app.tar.gz src/b.ts'))).toEqual(['dist/app.tar.gz', 'src/b.ts']);
    // 普通散文前缀不受影响。
    expect(linkUrls(runOnText('对比 src/a.ts 和 src/b.ts'))).toEqual(['src/a.ts', 'src/b.ts']);
    // 已知误伤(显式钉住):散文里紧挨着「含分隔符、无扩展名」的片段会被连坐。
    expect(linkUrls(runOnText('见 /etc src/a.ts'))).toEqual([]);
    // 换行不算被空格截断。
    expect(linkUrls(runOnText('C:\\Program\n见 src/a.ts'))).toEqual(['src/a.ts']);
  });

  it('右边界覆盖全部段内字符与分隔符,不切出错误前缀', () => {
    // 只排除字母数字不够:SEG 还允许 `_ ~ @ + -` 与 CJK,分隔符也会漏过去(review 实捉)。
    expect(linkUrls(runOnText('见 src/foo.ts/bar'))).toEqual([]);
    expect(linkUrls(runOnText('见 src/file.tsx_backup'))).toEqual([]);
    expect(linkUrls(runOnText('见 src/foo.ts~'))).toEqual([]);
    // `.` 与 `:` 刻意不排除:句末句点与 `:line` 后缀是最常见的紧随字符。
    expect(linkUrls(runOnText('见 src/a.ts.'))).toEqual(['src/a.ts']);
    expect(linkUrls(runOnText('见 src/a.png:12 行'))).toEqual(['src/a.png:12']);
  });

  it('超长扩展名整条不动,**不得截断成前 10 个字符**', () => {
    // 没有右边界时 `\.[A-Za-z0-9]{1,10}` 会贪心吃前 10 个字符然后收工:
    //   src/file.typescriptreact → 链接 `src/file.typescript` + 正文残留 `react`
    // 而截断后的前缀形状是「分隔符+扩展名」= 非歧义,远程会话断链时会被加下划线、
    // 允许点击,点开的是一个**不存在的错误路径**(PR #1144 review 实捉,移动端同步)。
    expect(linkUrls(runOnText('打开 src/file.typescriptreact 看看'))).toEqual([]);
    // 边界两侧各钉一个:恰好 10 个字符仍识别,11 个就整条拒绝。
    expect(linkUrls(runOnText('见 a/b.abcdefghij'))).toEqual(['a/b.abcdefghij']);
    expect(linkUrls(runOnText('见 a/b.abcdefghijk'))).toEqual([]);
    // 多段扩展名与紧跟的 CJK / 行号后缀不受影响。
    expect(linkUrls(runOnText('解包 dist/app.tar.gz'))).toEqual(['dist/app.tar.gz']);
    expect(linkUrls(runOnText('见 src/a.png。'))).toEqual(['src/a.png']);
    expect(linkUrls(runOnText('见 src/a.png:12 行'))).toEqual(['src/a.png:12']);
  });

  it('已经在 link 里的文本不碰(避免嵌套链接)', () => {
    const inner: Text = { type: 'text', value: 'src/App.tsx' };
    const link: Link = { type: 'link', url: 'src/App.tsx', children: [inner] };
    const para: Paragraph = { type: 'paragraph', children: [link] };
    const tree: Root = { type: 'root', children: [para] };
    transform(tree);
    const kids = (tree.children[0] as Paragraph).children;
    expect(kids).toHaveLength(1);
    expect((kids[0] as Link).children).toHaveLength(1);
    expect(((kids[0] as Link).children[0] as Text).value).toBe('src/App.tsx');
  });

  it('已知限制:中文紧贴路径无空白边界时,前导中文会被并入 token', () => {
    // CJK 既可能是 prose(见)也可能是真实目录名(我的看板),词法层无法区分。
    // 紧贴无空白时,前导"见"被并进路径 → "见src/App.tsx" 解析不到真实文件 →
    // 走现有链路降级成纯文本,最终仍然点不动(与现状一致,非回退);拿不到干净的
    // src/App.tsx 而已。
    expect(linkUrls(runOnText('见src/App.tsx'))).toEqual(['见src/App.tsx']);
  });

  it('已知限制:中文黏连两条真路径会吞成一个 token,两条都点不亮', () => {
    // 中间的"和"被当成路径段,整串成一个 token,解析不到 → 两条真路径都降级纯
    // 文本。比"前导紧贴"影响更大;救它只能把 CJK 当分隔符,但会反过来切断
    // docs/设计稿/index.md 里的中文目录名,得不偿失,故不做。
    expect(linkUrls(runOnText('改了 a/b.ts和c/d.ts'))).toEqual(['a/b.ts和c/d.ts']);
  });

  it('负例:版本号 / 宽高比等会进 candidate,但靠 resolve 闸门兜底不变 chip', () => {
    // 16/9.0、a/b.c 形状上满足"带分隔符 + 扩展名",会被切成 candidate link;
    // 但主进程 resolve 找不到真实文件 → 现有链路渲染成纯 <span>,不会变 chip。
    // tokenizer 单测只能固化"进 candidate"这一层;"不变 chip"由 resolve 闸门保证。
    expect(linkUrls(runOnText('比例 16/9.0 居中'))).toEqual(['16/9.0']);
    expect(linkUrls(runOnText('记作 a/b.c 即可'))).toEqual(['a/b.c']);
  });

  it('切出的 link 带 data-bare-path 标记(渲染层据此走「只加下划线」分支)', () => {
    // DESIGN.md §14.5:正文裸写的路径点亮后保持正文字体,不套等宽 chip —— 它的
    // 未点亮态是普通正文,套等宽会让同一句里点亮/未点亮的路径三处齐变。作者手写的
    // `[label](path)` 不带这个标记,继续按 label 形态决定 chip。
    const out = runOnText('见 src/App.tsx 第 20 行');
    const link = out.find((c): c is Link => c.type === 'link');
    expect(link, '未切出 link 节点').toBeDefined();
    expect(link!.data?.hProperties).toMatchObject({ 'data-bare-path': '' });
  });

  it('完全没有路径的句子原样不动', () => {
    const out = runOnText('这是一句普通的中文,没有任何路径。');
    expect(out).toHaveLength(1);
    expect(out[0].type).toBe('text');
  });
});