Repository navigation
fix(react,vue): keep streaming carets out of input documents #516
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
onmax
wants to merge
2
commits into
comarkdown:main
Choose a base branch
from
onmax:fix/caret-immutable
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| import { describe, expect, it } from 'vitest' | ||
| import { renderToString } from 'react-dom/server' | ||
| import { createMarkdownParser, parseMarkdown } from 'comark' | ||
| import { MarkdownDocument } from '../src/components/MarkdownDocument' | ||
|
|
||
| function freeze(value: unknown): void { | ||
| if (value && typeof value === 'object') { | ||
| Object.values(value).forEach(freeze) | ||
| Object.freeze(value) | ||
| } | ||
| } | ||
|
|
||
| describe('streaming caret', () => { | ||
| it.each(['Hello.', '> Hello **world**'])('preserves the input when rendering %s repeatedly', async (source) => { | ||
| const document = await parseMarkdown(source) | ||
| const original = structuredClone(document) | ||
| freeze(document) | ||
|
|
||
| for (let i = 0; i < 3; i++) { | ||
| const html = renderToString( | ||
| <MarkdownDocument | ||
| value={document} | ||
| streaming | ||
| caret={{ class: 'test-caret' }} | ||
| /> | ||
| ) | ||
| expect(html.match(/class="test-caret"/g)).toHaveLength(1) | ||
| expect(document).toEqual(original) | ||
| } | ||
| expect( | ||
| renderToString( | ||
| <MarkdownDocument | ||
| value={document} | ||
| caret={{ class: 'test-caret' }} | ||
| /> | ||
| ) | ||
| ).not.toContain('test-caret') | ||
| }) | ||
|
|
||
| it.each(['', 'plain text', '<!-- trailing comment -->'])( | ||
| 'appends a caret after unwrapped content: %s', | ||
| async (source) => { | ||
| const document = await parseMarkdown(source, { unwrap: true }) | ||
| const original = structuredClone(document) | ||
| freeze(document) | ||
| const html = renderToString( | ||
| <MarkdownDocument | ||
| value={document} | ||
| streaming | ||
| caret={{ class: 'test-caret' }} | ||
| /> | ||
| ) | ||
|
|
||
| expect(html.match(/class="test-caret"/g)).toHaveLength(1) | ||
| expect(document).toEqual(original) | ||
| } | ||
| ) | ||
|
|
||
| it('leaves the caret out when streaming is disabled', async () => { | ||
| const document = await parseMarkdown('Hello.') | ||
| const original = structuredClone(document) | ||
| freeze(document) | ||
| const html = renderToString( | ||
| <MarkdownDocument | ||
| value={document} | ||
| caret={{ class: 'test-caret' }} | ||
| /> | ||
| ) | ||
|
|
||
| expect(html).not.toContain('test-caret') | ||
| expect(document).toEqual(original) | ||
| }) | ||
|
|
||
| it('does not add carets to documents reused by the streaming parser', async () => { | ||
| const parse = createMarkdownParser() | ||
| for (const source of ['First\n\nTail', 'First\n\nTail grows', 'First\n\nTail grows again']) { | ||
| const document = await parse(source, { streaming: true }) | ||
| const original = structuredClone(document) | ||
| const html = renderToString( | ||
| <MarkdownDocument | ||
| value={document} | ||
| streaming | ||
| caret={{ class: 'test-caret' }} | ||
| /> | ||
| ) | ||
| expect(html.match(/class="test-caret"/g)).toHaveLength(1) | ||
| expect(document).toEqual(original) | ||
| } | ||
| }) | ||
|
|
||
| it('leaves an empty document empty', async () => { | ||
| const document = await parseMarkdown('') | ||
| expect( | ||
| renderToString( | ||
| <MarkdownDocument | ||
| value={document} | ||
| streaming | ||
| caret={{ class: 'test-caret' }} | ||
| /> | ||
| ) | ||
| ).not.toContain('test-caret') | ||
| }) | ||
| }) |
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 |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| import { describe, expect, it } from 'vitest' | ||
| import { createSSRApp, h } from 'vue' | ||
| import { renderToString } from '@vue/server-renderer' | ||
| import { createMarkdownParser, parseMarkdown } from 'comark' | ||
| import { MarkdownDocument } from '../src/components/MarkdownDocument.ts' | ||
|
|
||
| function freeze(value: unknown): void { | ||
| if (value && typeof value === 'object') { | ||
| Object.values(value).forEach(freeze) | ||
| Object.freeze(value) | ||
| } | ||
| } | ||
|
|
||
| describe('streaming caret', () => { | ||
| it.each(['Hello.', '> Hello **world**'])('preserves the input when rendering %s repeatedly', async (source) => { | ||
| const document = await parseMarkdown(source) | ||
| const original = structuredClone(document) | ||
| freeze(document) | ||
|
|
||
| for (let i = 0; i < 3; i++) { | ||
| const html = await renderToString( | ||
| createSSRApp(() => h(MarkdownDocument, { value: document, streaming: true, caret: { class: 'test-caret' } })) | ||
| ) | ||
| expect(html.match(/class="test-caret"/g)).toHaveLength(1) | ||
| expect(document).toEqual(original) | ||
| } | ||
| expect( | ||
| await renderToString(createSSRApp(() => h(MarkdownDocument, { value: document, caret: { class: 'test-caret' } }))) | ||
| ).not.toContain('test-caret') | ||
| }) | ||
|
|
||
| it.each(['', 'plain text', '<!-- trailing comment -->'])( | ||
| 'appends a caret after unwrapped content: %s', | ||
| async (source) => { | ||
| const document = await parseMarkdown(source, { unwrap: true }) | ||
| const original = structuredClone(document) | ||
| freeze(document) | ||
| const html = await renderToString( | ||
| createSSRApp(() => h(MarkdownDocument, { value: document, streaming: true, caret: { class: 'test-caret' } })) | ||
| ) | ||
|
|
||
| expect(html.match(/class="test-caret"/g)).toHaveLength(1) | ||
| expect(document).toEqual(original) | ||
| } | ||
| ) | ||
|
|
||
| it('leaves the caret out when streaming is disabled', async () => { | ||
| const document = await parseMarkdown('Hello.') | ||
| const original = structuredClone(document) | ||
| freeze(document) | ||
| const html = await renderToString( | ||
| createSSRApp(() => h(MarkdownDocument, { value: document, caret: { class: 'test-caret' } })) | ||
| ) | ||
|
|
||
| expect(html).not.toContain('test-caret') | ||
| expect(document).toEqual(original) | ||
| }) | ||
|
|
||
| it('does not add carets to documents reused by the streaming parser', async () => { | ||
| const parse = createMarkdownParser() | ||
| for (const source of ['First\n\nTail', 'First\n\nTail grows', 'First\n\nTail grows again']) { | ||
| const document = await parse(source, { streaming: true }) | ||
| const original = structuredClone(document) | ||
| const html = await renderToString( | ||
| createSSRApp(() => h(MarkdownDocument, { value: document, streaming: true, caret: { class: 'test-caret' } })) | ||
| ) | ||
| expect(html.match(/class="test-caret"/g)).toHaveLength(1) | ||
| expect(document).toEqual(original) | ||
| } | ||
| }) | ||
|
|
||
| it('leaves an empty document empty', async () => { | ||
| const document = await parseMarkdown('') | ||
| expect( | ||
| await renderToString( | ||
| createSSRApp(() => h(MarkdownDocument, { value: document, streaming: true, caret: { class: 'test-caret' } })) | ||
| ) | ||
| ).not.toContain('test-caret') | ||
| }) | ||
| }) |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Script executed:
Repository: comarkdown/comark
Length of output: 24186
Script executed:
Repository: comarkdown/comark
Length of output: 24186
Script executed:
Repository: comarkdown/comark
Length of output: 15331
Script executed:
Repository: comarkdown/comark
Length of output: 11779
Script executed:
Repository: comarkdown/comark
Length of output: 6464
Script executed:
Repository: comarkdown/comark
Length of output: 6417
Insert the caret at the discovered text position in both framework paths.
A backward loop that only stops at a top-level string is not sufficient. It leaves the string unchanged and then appends the caret after trailing comments or elements. The helper has the same defect for an element whose text child has trailing siblings. Insert the caret immediately after the discovered string, and append at the end only when no text node exists.
Suggested fix
Committable suggestion