@incremark/core

核心解析器库，框架无关。

安装

pnpm add @incremark/core

IncremarkParser

增量 Markdown 解析器类。

构造函数

new IncremarkParser(options?: ParserOptions)

方法

append(chunk)

追加内容并返回增量更新。

append(chunk: string): IncrementalUpdate

参数：

• chunk - 要追加的文本片段

返回值：

• IncrementalUpdate - 本次更新的块信息

finalize()

标记解析完成，处理剩余的待处理内容。

finalize(): IncrementalUpdate

reset()

重置解析器状态。

reset(): void

render(content)

一次性渲染完整 Markdown（reset + append + finalize）。

render(content: string): IncrementalUpdate

参数：

• content - 完整的 Markdown 内容

返回值：

• IncrementalUpdate - 解析结果

getBuffer()

获取当前缓冲区内容。

getBuffer(): string

getCompletedBlocks()

获取所有已完成的块。

getCompletedBlocks(): ParsedBlock[]

getAst()

获取当前完整的 AST。

getAst(): Root

setOnChange(callback)

设置状态变化回调（用于 DevTools）。

setOnChange(callback: ((state: ParserState) => void) | undefined): void

createIncremarkParser

工厂函数，创建解析器实例。

function createIncremarkParser(options?: ParserOptions): IncremarkParser

类型定义

ParserOptions

interface ParserOptions {
  /** 启用 GFM 扩展 */
  gfm?: boolean
  /** 启用 ::: 容器语法 */
  containers?: boolean | ContainerConfig
  /** 自定义块边界检测函数 */
  blockBoundaryDetector?: (content: string, position: number) => boolean
  /** micromark 扩展 */
  extensions?: Extension[]
  /** mdast 扩展 */
  mdastExtensions?: Extension[]
  /** 状态变化回调 */
  onChange?: (state: ParserState) => void
}

ContainerConfig

interface ContainerConfig {
  /** 容器标记字符，默认 ':' */
  marker?: string
  /** 最小标记长度，默认 3 */
  minMarkerLength?: number
  /** 允许的容器名称 */
  allowedNames?: string[]
}

ParsedBlock

interface ParsedBlock {
  /** 块的唯一 ID */
  id: string
  /** 块状态 */
  status: BlockStatus
  /** AST 节点 */
  node: RootContent
  /** 原始文本起始位置 */
  startOffset: number
  /** 原始文本结束位置 */
  endOffset: number
  /** 原始文本内容 */
  rawText: string
}

BlockStatus

type BlockStatus = 'pending' | 'stable' | 'completed'

IncrementalUpdate

interface IncrementalUpdate {
  /** 新完成的块 */
  completed: ParsedBlock[]
  /** 更新的块 */
  updated: ParsedBlock[]
  /** 待处理的块 */
  pending: ParsedBlock[]
  /** 完整 AST */
  ast: Root
}

ParserState

interface ParserState {
  completedBlocks: ParsedBlock[]
  pendingBlocks: ParsedBlock[]
  markdown: string
  ast: Root
}

检测器函数

detectFenceStart

检测代码块开始。

function detectFenceStart(line: string): { char: string; length: number; indent: number } | null

detectFenceEnd

检测代码块结束。

function detectFenceEnd(line: string, fenceChar: string, fenceLength: number): boolean

isEmptyLine

检测空行。

function isEmptyLine(line: string): boolean

isHeading

检测标题行。

function isHeading(line: string): boolean

isThematicBreak

检测分隔线。

function isThematicBreak(line: string): boolean

isListItemStart

检测列表项开始。

function isListItemStart(line: string): boolean

isBlockquoteStart

检测引用开始。

function isBlockquoteStart(line: string): boolean