99 lines
3.4 KiB
TypeScript
99 lines
3.4 KiB
TypeScript
/** Tests for the documentation website projection adapter. */
|
|
|
|
import { mkdirSync, mkdtempSync, rmSync, writeFileSync } from 'node:fs'
|
|
import { tmpdir } from 'node:os'
|
|
import { join } from 'node:path'
|
|
import { afterEach, describe, expect, it } from 'vitest'
|
|
import type { DocsPage } from '../website/docs.ts'
|
|
import { addProjectionFrontmatter, rewriteMarkdown } from './project-doc-site.ts'
|
|
|
|
const roots: string[] = []
|
|
|
|
afterEach(() => {
|
|
for (const root of roots.splice(0)) rmSync(root, { recursive: true, force: true })
|
|
})
|
|
|
|
function fixture(): { root: string; pages: DocsPage[] } {
|
|
const root = mkdtempSync(join(tmpdir(), 'dsh-doc-site-'))
|
|
roots.push(root)
|
|
mkdirSync(join(root, 'docs'), { recursive: true })
|
|
mkdirSync(join(root, 'packages'), { recursive: true })
|
|
writeFileSync(join(root, 'docs/a.md'), '# A\n')
|
|
writeFileSync(join(root, 'docs/b.md'), '# B\n')
|
|
writeFileSync(join(root, 'packages/tool.ts'), 'one\ntwo\n')
|
|
writeFileSync(join(root, 'packages/logo.svg'), '<svg/>\n')
|
|
return {
|
|
root,
|
|
pages: [
|
|
{ source: 'docs/a.md', route: 'en/a.md', label: 'A', sidebar: 'en-docs', section: 'Test', order: 1 },
|
|
{ source: 'docs/b.md', route: 'en/reference/b.md', label: 'B', sidebar: 'en-docs', section: 'Test', order: 2 },
|
|
],
|
|
}
|
|
}
|
|
|
|
describe('rewriteMarkdown', () => {
|
|
it('maps published pages and pins unpublished source links', () => {
|
|
const { root, pages } = fixture()
|
|
const source = '[B](b.md#part) [source](../packages/tool.ts:2) [web](https://example.com)\n'
|
|
expect(rewriteMarkdown(source, {
|
|
sourcePath: 'docs/a.md',
|
|
route: 'en/a.md',
|
|
pages,
|
|
repoRoot: root,
|
|
repositoryRef: 'abc123',
|
|
})).toBe(
|
|
'[B](./reference/b.md#part) '
|
|
+ '[source](https://github.com/deepseek-harness/deepseek-harness/blob/abc123/packages/tool.ts#L2) '
|
|
+ '[web](https://example.com)\n',
|
|
)
|
|
})
|
|
|
|
it('uses raw GitHub content for unpublished images', () => {
|
|
const { root, pages } = fixture()
|
|
expect(rewriteMarkdown('\n', {
|
|
sourcePath: 'docs/a.md',
|
|
route: 'en/a.md',
|
|
pages,
|
|
repoRoot: root,
|
|
repositoryRef: 'abc123',
|
|
})).toBe('\n')
|
|
})
|
|
|
|
it('does not rewrite Markdown-looking text inside code fences', () => {
|
|
const { root, pages } = fixture()
|
|
const source = '```md\n[B](b.md)\n```\n'
|
|
expect(rewriteMarkdown(source, {
|
|
sourcePath: 'docs/a.md',
|
|
route: 'en/a.md',
|
|
pages,
|
|
repoRoot: root,
|
|
repositoryRef: 'abc123',
|
|
})).toBe(source)
|
|
})
|
|
|
|
it('fails loud when a relative target is missing', () => {
|
|
const { root, pages } = fixture()
|
|
expect(() => rewriteMarkdown('[missing](missing.md)\n', {
|
|
sourcePath: 'docs/a.md',
|
|
route: 'en/a.md',
|
|
pages,
|
|
repoRoot: root,
|
|
repositoryRef: 'abc123',
|
|
})).toThrow('links to missing path "missing.md"')
|
|
})
|
|
})
|
|
|
|
describe('addProjectionFrontmatter', () => {
|
|
it('adds frontmatter to an ordinary Markdown page', () => {
|
|
expect(addProjectionFrontmatter('# Guide\n', 'docs/guide.md')).toBe(
|
|
'---\neditSource: "docs/guide.md"\n---\n\n# Guide\n',
|
|
)
|
|
})
|
|
|
|
it('extends existing VitePress frontmatter', () => {
|
|
expect(addProjectionFrontmatter('---\nlayout: home\n---\n', 'docs/index.md')).toBe(
|
|
'---\neditSource: "docs/index.md"\nlayout: home\n---\n',
|
|
)
|
|
})
|
|
})
|