feat(parse)!: heal incomplete markdown only while streaming #405
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,7 +26,7 @@ import shiki from 'comark/plugins/shiki' | |
|
|
||
| const result = await parseMarkdown(source, { | ||
| autoUnwrap: true, // Remove <p> wrappers from single-paragraph containers | ||
| autoClose: 'streaming', // Auto-close incomplete syntax while streaming | ||
| plugins: [shiki()] // HTML parsing is on by default via the html plugin | ||
| }) | ||
|
|
||
|
|
@@ -296,7 +296,7 @@ type Node = | |
| ```typescript | ||
| interface ParserOptions { | ||
| autoUnwrap?: boolean // default: true | ||
| autoClose?: boolean | 'streaming' | AutoCloseFunction // default: 'streaming' | ||
| unwrap?: boolean | string | string[] // strip top-level wrapper tags, e.g. 'p' (default: false) | ||
| /** @deprecated Prefer registerDefaultPlugins: false */ | ||
| html?: boolean // default: true | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -327,7 +327,7 @@ const document = await parseMarkdown(md, { plugins: [emoji()] }) | |
| { | ||
| plugins: ComarkPlugin[], // ordered array, not a record | ||
| autoUnwrap: true, // removes <p> from single-paragraph containers | ||
| autoClose: 'streaming', // completes incomplete syntax while streaming | ||
| // HTML, components, attributes, alerts, task-list, frontmatter are on by default | ||
| } | ||
| ``` | ||
|
|
@@ -687,4 +687,4 @@ These features may be added in a future release. If your project relies on bindi | |
| | Prose components | `components/prose/Prose*.vue` | `components/prose/Prose*.vue` | | ||
| | Render slot | `<MDCSlot />` | `<slot />` | | ||
| | Unwrap slot | `<MDCSlot unwrap="p" />` or `<slot mdc-unwrap="p" />` | `<slot unwrap="p" />` | | ||
| | Streaming | Not supported | `streaming` prop, which also turns on `autoClose` healing | | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,7 +6,7 @@ A guide for using Comark in AI agent and LLM-powered applications where markdown | |
|
|
||
| LLMs stream markdown token-by-token. Standard markdown parsers expect complete input. They fail or produce broken output on partial streams. Comark was built to handle exactly this: | ||
|
|
||
| - **`autoClose`** (default: `'streaming'`): incomplete syntax like `**bold text` is closed when you parse with `{ streaming: true }`, so partial tokens always render correctly. A plain parse leaves it as written; set `autoClose: true` to close on every parse | ||
| - **Streaming mode**: re-renders efficiently as content arrives | ||
| - **Caret indicator**: shows a live cursor during generation | ||
| - **ANSI rendering**: styled terminal output for CLI agents | ||
|
|
@@ -297,7 +297,7 @@ export const ChatMarkdown = defineMarkdownComponent({ | |
| shiki({ themes: { light: githubDark, dark: githubDark } }), | ||
| ], | ||
| components: { Math, alert: Alert }, | ||
| autoClose: 'streaming', | ||
| }) | ||
| ``` | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -53,7 +53,7 @@ interface MarkdownDocument { | |
| ```typescript | ||
| interface ParserOptions { | ||
| autoUnwrap?: boolean // Remove unnecessary <p> wrappers (default: true) | ||
| autoClose?: boolean | 'streaming' // Auto-close unclosed syntax (default: 'streaming') | ||
|
coderabbitai[bot] marked this conversation as resolved.
Outdated
|
||
| plugins?: ComarkPlugin[] // Enable plugins (e.g., highlight, emoji, toc) | ||
| } | ||
| ``` | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -330,7 +330,7 @@ The `caret` prop appends a blinking cursor indicator to the last text node durin | |
| <Markdown value={content} streaming={isStreaming} caret={{ class: 'my-caret' }} /> | ||
| ``` | ||
|
|
||
| `autoClose` defaults to `'streaming'`: incomplete syntax like `**bold text` is closed when the `streaming` prop is set, and left as written otherwise. | ||
|
|
||
| --- | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -61,7 +61,7 @@ The migration has two parts: **Core Package** (programmatic API) and **Nuxt Modu | |
| { | ||
| plugins: ComarkPlugin[], // ordered array, not a record | ||
| autoUnwrap: true, // removes <p> from single-paragraph containers | ||
| autoClose: 'streaming', // completes incomplete syntax while streaming | ||
| // HTML, components, attributes, alerts, task-list, frontmatter are on by default | ||
| } | ||
| ``` | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -437,8 +437,16 @@ describe('renderAnsi', () => { | |
| }) | ||
|
|
||
| it('passes parser and renderer options through', async () => { | ||
| // `autoClose: false` matches the default for a non-streaming render, so force | ||
| // healing on to prove the option reaches the parser. | ||
| const output = await renderAnsi('**bold', { autoClose: true, colors: false }) | ||
| expect(output).not.toContain('\x1B[') | ||
| expect(output).toContain('bold') | ||
| expect(output).not.toContain('\\*\\*bold') | ||
| }) | ||
|
|
||
| it('leaves incomplete markdown alone by default', async () => { | ||
| const output = await renderAnsi('**bold', { colors: false }) | ||
| expect(output).toContain('\\*\\*bold') | ||
| }) | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -68,7 +68,14 @@ describe('renderHtml', () => { | |
| }) | ||
|
|
||
| it('passes parser options through', async () => { | ||
| // `autoClose: false` matches the default for a non-streaming render, so force | ||
| // healing on to prove the option reaches the parser. | ||
| const html = await renderHtml('**bold', { autoClose: true }) | ||
| expect(html).toContain('<strong>') | ||
| }) | ||
|
|
||
| it('leaves incomplete markdown alone by default', async () => { | ||
| const html = await renderHtml('**bold') | ||
| expect(html).toContain('**bold') | ||
| expect(html).not.toContain('<strong>') | ||
| }) | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -151,7 +151,7 @@ export async function Markdown({ | |
| ) | ||
| } | ||
|
|
||
| const parsed = await parseMarkdown(source, { ...parseOptions, plugins }, { streaming }) | ||
|
|
||
| return ( | ||
| <MarkdownDocument | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -35,7 +35,14 @@ function MarkdownContent({ | |
| ) | ||
| } | ||
|
|
||
| export function MarkdownClient({ | ||
| children, | ||
| value, | ||
| options = {}, | ||
| plugins = [], | ||
| streaming = false, | ||
| ...rest | ||
| }: MarkdownProps) { | ||
| const content = isMarkdownDocument(value) | ||
| ? value | ||
| : children | ||
|
|
@@ -46,8 +53,13 @@ export function MarkdownClient({ children, value, options = {}, plugins = [], .. | |
| // Note: options/plugins should be stable references (defined outside render or memoized). | ||
| // Pre-parsed documents resolve immediately without calling parseMarkdown(). | ||
| const parsePromise = useMemo( | ||
| () => | ||
| isMarkdownDocument(content) | ||
| ? Promise.resolve(content) | ||
| : // `streaming` must reach the parser, not just the renderer: it drives | ||
| // auto-close healing and incremental node reuse. | ||
| parseMarkdown(content, { ...options, plugins }, { streaming }), | ||
| [content, streaming] | ||
| ) | ||
|
|
||
| // Keep showing the previous parsed result while a new parse is pending — | ||
|
|
@@ -58,6 +70,7 @@ export function MarkdownClient({ children, value, options = {}, plugins = [], .. | |
| <Suspense fallback={null}> | ||
| <MarkdownContent | ||
| parsePromise={deferredPromise} | ||
| streaming={streaming} | ||
| {...rest} | ||
| /> | ||
| </Suspense> | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| import { describe, expect, it } from 'vitest' | ||
| import React from 'react' | ||
| import { renderToReadableStream } from 'react-dom/server' | ||
| import { Markdown } from '../src/index' | ||
|
|
||
| async function renderAsync(element: React.ReactElement): Promise<string> { | ||
| const stream = await renderToReadableStream(element) | ||
| await stream.allReady | ||
| return new Response(stream).text() | ||
| } | ||
|
|
||
| // The `streaming` prop drives the renderer (caret, stream components) but it also | ||
| // has to reach the parser: auto-close heals only on a streaming parse. | ||
| describe('<Markdown streaming>', () => { | ||
| it('heals incomplete markdown while streaming', async () => { | ||
| const html = await renderAsync( | ||
| <Markdown | ||
| value="Hello **wor" | ||
| streaming | ||
| /> | ||
| ) | ||
| expect(html).toContain('<strong>') | ||
| expect(html).toContain('wor') | ||
| }) | ||
|
|
||
| it('leaves incomplete markdown alone when not streaming', async () => { | ||
| const html = await renderAsync(<Markdown value="Hello **wor" />) | ||
| expect(html).not.toContain('<strong>') | ||
| expect(html).toContain('**wor') | ||
| }) | ||
|
|
||
| it('still heals a non-streaming parse when asked explicitly', async () => { | ||
| const html = await renderAsync( | ||
| <Markdown | ||
| value="Hello **wor" | ||
| options={{ autoClose: true }} | ||
| /> | ||
| ) | ||
| expect(html).toContain('<strong>') | ||
| }) | ||
| }) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -65,7 +65,7 @@ and wrap this component in a `<svelte:boundary>` for pending/error states. | |
| : // `parse` directly mutates `plugins` which creates an infinite effect loop | ||
| // so we copy it before passing it in so it gets a regular JS array and we get to still | ||
| // track dependencies from an external perspective | ||
| await parseMarkdown(content, { ...options, ...(unwrap ? { unwrap } : {}), plugins: [...plugins] }, { streaming }), | ||
| ) | ||
| </script> | ||
|
|
||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.