Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Support Incremental Parsing for Streaming Markdown Input/支持流式 Markdown 输入的增量解析

Aperta
  • Qualcosa non va?
#414 1 commento 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
java
Ambito
compilers

Direzione di ricerca

Inizia esaminando Parser.parse(String markdown) e la logica esistente di continuazione del parser a blocchi descritta tramite canContinue(). Definisci come un ParserContext conserverebbe i parser aperti, la radice dell’AST e la posizione corrente tra i chunk aggiunti. Il lavoro sarebbe considerato completato quando esistano un’API incrementale e un comportamento concordati che aggiornino l’AST esistente senza rianalizzare l’input invariato e gli scenari di streaming siano coperti dai test.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement
English

Background
Currently, commonmark-java parses Markdown via Parser.parse(String markdown), which always processes the entire input from scratch and rebuilds the AST.
In streaming scenarios (e.g., live Markdown preview, collaborative editing, chat messages), new content is appended continuously. Re-parsing the whole document each time is inefficient and can cause performance issues for large documents.

Request
I would like to request incremental parsing support — the ability to parse only the newly added Markdown content and update the existing AST without re-parsing unchanged parts.

Possible Approach

  • Maintain a parsing context (ParserContext) that stores:
    • Current open block parsers
    • AST root node
    • Current line number / position
  • Add a method like: 
    Node parseIncremental(String newMarkdown, ParserContext context);
    which:
    • Resumes parsing from the saved context
    • Continues open blocks if possible (canContinue() logic)
    • Creates new blocks for new content
    • Parses inline elements only for new blocks
  • Update the AST in place, avoiding full rebuild.

Benefits

  • Significant performance improvement for streaming or real-time editing scenarios.
  • Reduced memory and CPU usage for large documents.
  • Enables more responsive applications using commonmark-java.

Example Use Case

Parser parser = Parser.builder().build();
ParserContext context = new ParserContext();

Node doc = parser.parseIncremental(initialMarkdown, context);
doc = parser.parseIncremental(newMarkdownChunk, context);

Would you consider adding this feature or providing hooks to implement it externally?

中文

背景
目前，commonmark-java 通过 Parser.parse(String markdown) 解析 Markdown，每次都会从头处理整个输入并重建 AST。
在流式场景（例如实时 Markdown 预览、协同编辑、聊天消息）中，内容会不断追加。每次都全量解析会导致性能浪费，尤其是文档较大时。

需求
希望能支持 增量解析 —— 只解析新增的 Markdown 内容，并在已有 AST 基础上更新，而不重新解析未变化的部分。

可能的实现思路

  • 维护一个解析上下文（ParserContext），保存：
    • 当前未闭合的块解析器
    • AST 根节点
    • 当前行号 / 位置
  • 增加一个方法，例如： 
    Node parseIncremental(String newMarkdown, ParserContext context);
    该方法：
    • 从保存的上下文恢复解析状态
    • 如果可能，继续旧块（依赖 canContinue() 逻辑）
    • 为新增内容创建新块
    • 仅对新增块进行行内解析
  • 在原 AST 上直接更新，避免全量重建。

好处

  • 在流式或实时编辑场景下显著提升性能。
  • 降低大文档的内存和 CPU 消耗。
  • 让基于 commonmark-java 的应用更加流畅、响应更快。

使用示例

Parser parser = Parser.builder().build();
ParserContext context = new ParserContext();

Node doc = parser.parseIncremental(initialMarkdown, context);
doc = parser.parseIncremental(newMarkdownChunk, context);
Lingua principale
Java
Stelle
2.7k
Fork
336
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di commonmark/commonmark-java

Tutte le issue di commonmark/commonmark-java

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.