Function parseModuleExamples

packages/tools/jsdocs/src/Jsdocs.ts:1359–1397

(block: JSDocBlock)

}

function parseModuleExamples(block: JSDocBlock): {
  readonly examples: ReadonlyArray<ParsedExample>
  readonly diagnostics: ReadonlyArray<JSDocDiagnostic>
} {
  const diagnostics: Array<JSDocDiagnostic> = []
  const examples: Array<ParsedExample> = []
  const exampleTitles = new Set<string>()
  const firstTagLine = block.tags[0]?.line ?? block.lines.length
  const lines = block.lines.slice(0, firstTagLine)
  let index = 0
  while (index < lines.length) {
    const trimmed = lines[index].trim()
    if (trimmed.startsWith("**Example**")) {
      const parsed = parseExample(lines, index)
      diagnostics.push(...parsed.diagnostics)
      if (parsed.example !== undefined) {
        const key = parsed.example.title.trim().toLowerCase()
        if (exampleTitles.has(key)) {
          diagnostics.push(diagnostic("duplicate-example", `Duplicate example title: ${parsed.example.title.trim()}`))
        }
        exampleTitles.add(key)
        examples.push(parsed.example)
      }
      index = Math.max(parsed.nextIndex, index + 1)
      continue
    }
    if (trimmed.startsWith("```")) {
      diagnostics.push(
        diagnostic("loose-ts-fence", "Code fences in module JSDoc must use **Example** (Title) sections")
      )
      index++
      while (index < lines.length && !lines[index].trim().startsWith("```")) index++
      if (index < lines.length) index++
      continue
    }
    index++
  }
  return { examples, diagnostics }
}

function joinBody(lines: ReadonlyArray<string>): string {
  let start = 0