deepseek-harness/scripts/verify-md-links.ts

/**
 * Verify that relative Markdown links, images, and definitions resolve — the
 * target file must exist AND a `#fragment` onto a Markdown target (including
 * a same-file `#anchor`) must name a real heading slug or explicit `<a id>`.
 * URL and root-absolute targets are excluded; query strings do not affect
 * resolution against the source file. The checker never rewrites, and
 * symlinked instruction files are deduped.
 */

import { existsSync, readFileSync } from 'node:fs'
import { dirname, relative, resolve } from 'node:path'
import type { Nodes } from 'mdast'
import { markdownHeadingLines, parseMarkdown, visitMarkdown } from './markdown.ts'
import { isArchivedAgentNotePath, uniqueRepoFiles } from './repo-files.ts'

const root = resolve(import.meta.dirname, '..')

/** Repo-authored Markdown checked for relative links. */
const PATTERNS = [
  'README.md',
  'README.zh.md',
  '.agents/notes/**/*.md',
  'docs/**/*.md',
  'packages/*.md',
  'packages/*/*.md',
  'packages/*/*/*.md',
  // Plugin detail documents that locale `meta.detail` names.
  'packages/*/*/docs/*.md',
  'AGENTS.md',
  '.agents/skills/**/*.md',
]

/**
 * Discover authored Markdown sources, deduplicating symlinks.
 * Archived notes are excluded as sources, but links to them remain checked.
 * @param scanRoot - absolute repository root; pass the same root to findViolations for matching diagnostics.
 * @returns forward-slash source paths relative to scanRoot.
 */
export function markdownLinkSourcePaths(scanRoot: string = root): string[] {
  return uniqueRepoFiles(scanRoot, PATTERNS, isArchivedAgentNotePath)
    .map(file => relative(scanRoot, file.abs).replaceAll('\\', '/'))
}

/** A broken relative link: a missing target path or a missing anchor on it. */
interface Violation {
  file: string
  /** 1-based line where the link/image/definition node starts. */
  line: number
  url: string
  /** What failed: the target file or the fragment onto it. */
  reason: 'target' | 'anchor'
}

/**
 * True for targets this gate must NOT check: scheme-qualified URLs (`https:`,
 * `mailto:`, …), protocol-relative (`//host`), and root-absolute (`/path`).
 * Pure in-page anchors (`#frag`) ARE checked, against the source file itself.
 */
function isExternal(url: string): boolean {
  if (url.startsWith('//')) return true
  if (url.startsWith('/')) return true
  // A scheme like `https:` / `mailto:` — a colon before any slash, dot, or hash.
  return /^[a-zA-Z][a-zA-Z0-9+.-]*:/.test(url)
}

/**
 * Strip the `#fragment` and `?query` from a link target, then percent-decode
 * the remaining path so an encoded target (`My%20File.md`, `READ%4DE.md`)
 * probes the real filename on disk, the way a Markdown renderer resolves it. A
 * malformed escape (`%zz`) makes `decodeURIComponent` throw; we keep the raw
 * path in that case so the link is reported as broken (a `%zz` target is not a
 * file anyone meant to link) rather than crashing the gate.
 */
function pathPart(url: string): string {
  const raw = url.replace(/[#?].*$/, '')
  try {
    return decodeURIComponent(raw)
  } catch {
    // decodeURIComponent throws only on a malformed percent-escape; the raw
    // string is then a path no renderer resolves, so fall through to the
    // existence check, which reports it broken.
    return raw
  }
}

/** The percent-decoded `#fragment` of a link target, or null when it has none. */
function fragmentPart(url: string): string | null {
  const hash = url.indexOf('#')
  if (hash === -1) return null
  const raw = url.slice(hash + 1).replace(/\?.*$/, '')
  try {
    return decodeURIComponent(raw)
  } catch {
    // Same stance as pathPart: a malformed escape names no anchor anyone
    // meant, so the raw text flows into the lookup and is reported missing.
    return raw
  }
}

/**
 * GitHub's heading-slug algorithm (lowercase; drop everything but letters,
 * numbers, underscores, spaces, hyphens; spaces become hyphens). Underscores
 * survive (`## Showcase: web_fetch` → `#showcase-web_fetch`), unlike
 * `gen-cordis-catalog`'s region-anchor slugs — the generator's headings are
 * always reachable through its explicit `<a id>` anchors, so the two need not
 * share one rule.
 * @param heading - the RENDERED heading text (Markdown syntax already gone).
 * @returns the anchor GitHub assigns the first occurrence of the heading.
 */
export function githubSlug(heading: string): string {
  return heading.toLowerCase().replace(/[^\p{L}\p{N}_ -]/gu, '').replaceAll(' ', '-')
}

/**
 * Every anchor one Markdown document exposes: each heading's GitHub slug —
 * computed from the RENDERED heading text, so links, images, inline code, and
 * emphasis inside a heading slug the way GitHub renders them — plus every
 * explicit `<a id="…">` that appears in real HTML flow (a fenced or inline
 * code sample and a commented-out anchor register nothing). Repeated slugs
 * get GitHub's occupied-set `-1`, `-2`, … suffixes: each collision bumps the
 * ORIGINAL slug's counter until a free name is found, so `Repeat`, `Repeat-1`,
 * `Repeat` yields `repeat`, `repeat-1`, `repeat-2`. Matching is exact —
 * element ids are case-sensitive.
 * @param source - the document's full Markdown text.
 * @param tree - the GFM parse of exactly `source`, when the caller already has it.
 * @returns the set of valid fragments for links into this document.
 */
export function documentAnchors(source: string, tree: Nodes = parseMarkdown(source)): Set<string> {
  const anchors = new Set<string>()
  const occurrences = new Map<string, number>()
  for (const heading of markdownHeadingLines(source, tree)) {
    const base = githubSlug(heading.text)
    let result = base
    let bump = occurrences.get(base) ?? 0
    while (anchors.has(result)) {
      bump += 1
      result = `${base}-${bump}`
    }
    occurrences.set(base, bump)
    anchors.add(result)
  }
  visitMarkdown(tree, (node: Nodes): void => {
    if (node.type !== 'html') return
    const html = node.value.replace(/<!--[\s\S]*?-->/g, '')
    for (const match of html.matchAll(/<a id="([^"]+)"/g)) anchors.add(match[1] ?? '')
  })
  return anchors
}

/** One Markdown file's link inputs and exposed anchors, collected from a single parse. */
export interface MarkdownLinkDocument {
  /** Link, image, and definition destinations with their 1-based start lines, in document order. */
  destinations: { url: string; line: number }[]
  /** Fragments that links into this document may name. */
  anchors: Set<string>
}

/** Per-run reads, parses, and target probes shared by every scanned source and link target. */
export interface MarkdownLinkCache {
  /** Read and parse one Markdown file at most once per run. */
  document: (absPath: string) => MarkdownLinkDocument
  /** Whether a resolved link target exists, probed at most once per path. */
  exists: (absPath: string) => boolean
}

function markdownLinkDocument(source: string): MarkdownLinkDocument {
  const tree = parseMarkdown(source)
  const destinations: MarkdownLinkDocument['destinations'] = []
  visitMarkdown(tree, (node: Nodes): void => {
    if ((node.type === 'link' || node.type === 'image' || node.type === 'definition') && 'url' in node) {
      destinations.push({ url: node.url, line: node.position?.start.line ?? 0 })
    }
  })
  return { destinations, anchors: documentAnchors(source, tree) }
}

/**
 * Create the memoized file reads and existence probes for one checker run.
 * A file that is both a scanned source and a fragment target parses once; the
 * repository is assumed not to change while the run lasts.
 * @returns the cache to pass to every {@link findViolations} call of the run.
 */
export function markdownLinkCache(): MarkdownLinkCache {
  const documents = new Map<string, MarkdownLinkDocument>()
  const existence = new Map<string, boolean>()
  return {
    document: (absPath) => {
      const hit = documents.get(absPath)
      if (hit) return hit
      const document = markdownLinkDocument(readFileSync(absPath, 'utf8'))
      documents.set(absPath, document)
      return document
    },
    exists: (absPath) => {
      const hit = existence.get(absPath)
      if (hit !== undefined) return hit
      const exists = existsSync(absPath)
      existence.set(absPath, exists)
      return exists
    },
  }
}

/**
 * Find every broken relative cross-link in one Markdown file via its AST: a
 * relative target that does not exist, or a fragment onto a Markdown file
 * (same-file `#anchor` links included) that names no heading slug or explicit
 * `<a id>` there. Fragments onto non-Markdown targets (`file.ts#L10`) carry
 * renderer-owned semantics and are not judged.
 * @param absPath - absolute path of the Markdown source to scan.
 * @param cache - parses and target probes shared across files for cross-link checks.
 * @param scanRoot - repository root violations are reported relative to.
 * @returns one entry per broken link, in document order.
 */
export function findViolations(
  absPath: string,
  cache: MarkdownLinkCache = markdownLinkCache(),
  scanRoot: string = root,
): Violation[] {
  const file = relative(scanRoot, absPath)
  const dir = dirname(absPath)
  const out: Violation[] = []
  for (const { url, line } of cache.document(absPath).destinations) {
    if (isExternal(url)) continue
    const target = pathPart(url)
    const resolved = target === '' ? absPath : resolve(dir, target)
    if (!cache.exists(resolved)) {
      out.push({ file, line, url, reason: 'target' })
      continue
    }
    const fragment = fragmentPart(url)
    if (fragment === null || !resolved.endsWith('.md')) continue
    if (!cache.document(resolved).anchors.has(fragment)) {
      out.push({ file, line, url, reason: 'anchor' })
    }
  }
  return out
}

if (process.argv[1] && import.meta.filename === resolve(process.argv[1])) {
  const files = markdownLinkSourcePaths(root)
  const cache = markdownLinkCache()
  const all = files.flatMap(file => findViolations(resolve(root, file), cache))
  const checked = files.length

  if (all.length === 0) {
    console.log(`verify-md-links: ${checked} file(s) checked, all relative cross-links and fragments resolve.`)
    process.exit(0)
  }

  console.error('verify-md-links: broken relative cross-links found:')
  for (const v of all) {
    console.error(`  ${v.file}:${v.line}  ${v.url}  (${v.reason === 'target' ? 'target does not exist' : 'no such anchor in target'})`)
  }
  process.exit(1)
}