Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fix issue with rich-text when nested in jsx objects #4485

Merged
merged 15 commits into from
May 1, 2024
Merged

Fix issue with rich-text when nested in jsx objects #4485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
32672a6
Add failing test to show issue with nesting mdx objects
jeffsee55 Apr 9, 2024
1fe4c74
Bump
jeffsee55 Apr 9, 2024
17550c5
Get broken nested mdx working
jeffsee55 Apr 19, 2024
2640ed4
Cleanup nesting logic
jeffsee55 Apr 19, 2024
69578bd
Cleanup
jeffsee55 Apr 19, 2024
0eb98d5
Add a few more test-cases to nested rich-text in jsx objects
jeffsee55 Apr 21, 2024
b3ad50a
Create old-bananas-walk.md
jeffsee55 Apr 21, 2024
08f9328
Remove broken test
jeffsee55 Apr 21, 2024
8b10e13
Merge branch 'nested-object-mdx-issue' of https://github.com/tinacms/…
jeffsee55 Apr 21, 2024
0228c51
Undo lockfile change
jeffsee55 Apr 21, 2024
fe3bd78
Undo change from another branch
jeffsee55 Apr 21, 2024
5d291e5
Update old-bananas-walk.md
jeffsee55 Apr 23, 2024
0cba561
update lock
jeffsee55 Apr 23, 2024
e2cd500
Undo lockfile change
jeffsee55 Apr 24, 2024
598bb59
Update .changeset/old-bananas-walk.md
jeffsee55 May 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/old-bananas-walk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@tinacms/mdx": patch
tinacms: patch
---

Fix issue where rich-text nested inside JSX objects wasn't being parsed/stringified properly.
2 changes: 1 addition & 1 deletion experimental-examples/kitchen-sink/tina/tina-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

33 changes: 33 additions & 0 deletions packages/@tinacms/mdx/src/next/tests/mdx-basic-nested-objects-2/field.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import { RichTextField } from '@tinacms/schema-tools'

export const field: RichTextField = {
name: 'body',
type: 'rich-text',
parser: { type: 'mdx' },
templates: [
{
name: 'Table',
fields: [
{
name: 'rows',
type: 'object',
list: true,
fields: [
{
name: 'columns',
type: 'object',
list: true,
fields: [
{
name: 'content',
type: 'object',
fields: [{ name: 'description', type: 'rich-text' }],
},
],
},
],
},
],
},
],
}
13 changes: 13 additions & 0 deletions packages/@tinacms/mdx/src/next/tests/mdx-basic-nested-objects-2/in.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Hello

<Table rows={[
{
columns: [
{
content: {
description: "# Hello"
}
}
]
}
]} />
13 changes: 13 additions & 0 deletions packages/@tinacms/mdx/src/next/tests/mdx-basic-nested-objects-2/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import { it, expect } from 'vitest'
import { parseMDX } from '../../../parse'
import { stringifyMDX } from '../../../stringify'
import { field } from './field'
import input from './in.md?raw'
import * as util from '../util'

it('matches input', () => {
const tree = parseMDX(input, field, (v) => v)
expect(util.print(tree)).toMatchFile(util.nodePath(__dirname))
const string = stringifyMDX(tree, field, (v) => v)
expect(string).toMatchFile(util.mdPath(__dirname))
})
50 changes: 50 additions & 0 deletions packages/@tinacms/mdx/src/next/tests/mdx-basic-nested-objects-2/node.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
{
"type": "root",
"children": [
{
"type": "p",
"children": [
{
"type": "text",
"text": "Hello"
}
]
},
{
"type": "mdxJsxFlowElement",
"name": "Table",
"children": [
{
"type": "text",
"text": ""
}
],
"props": {
"rows": [
{
"columns": [
{
"content": {
"description": {
"type": "root",
"children": [
{
"type": "h1",
"children": [
{
"type": "text",
"text": "Hello"
}
]
}
]
}
}
}
]
}
]
}
}
]
}
3 changes: 3 additions & 0 deletions packages/@tinacms/mdx/src/next/tests/mdx-basic-nested-objects-2/out.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Hello

<Table rows={[{ columns: [{ content: { description: "# Hello\n" } }] }]} />
33 changes: 33 additions & 0 deletions packages/@tinacms/mdx/src/next/tests/mdx-basic-nested-objects-3/field.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import { RichTextField } from '@tinacms/schema-tools'

export const field: RichTextField = {
name: 'body',
type: 'rich-text',
parser: { type: 'mdx' },
templates: [
{
name: 'Table',
fields: [
{
name: 'rows',
type: 'object',
list: true,
fields: [
{
name: 'columns',
type: 'object',
list: true,
fields: [
{
name: 'content',
type: 'rich-text',
templates: [{ name: 'World', fields: [] }],
},
],
},
],
},
],
},
],
}
11 changes: 11 additions & 0 deletions packages/@tinacms/mdx/src/next/tests/mdx-basic-nested-objects-3/in.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Hello

<Table rows={[
{
columns: [
{
content: "# Hello <World />"
}
]
}
]} />
13 changes: 13 additions & 0 deletions packages/@tinacms/mdx/src/next/tests/mdx-basic-nested-objects-3/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import { it, expect } from 'vitest'
import { parseMDX } from '../../../parse'
import { stringifyMDX } from '../../../stringify'
import { field } from './field'
import input from './in.md?raw'
import * as util from '../util'

it('matches input', () => {
const tree = parseMDX(input, field, (v) => v)
expect(util.print(tree)).toMatchFile(util.nodePath(__dirname))
const string = stringifyMDX(tree, field, (v) => v)
expect(string).toMatchFile(util.mdPath(__dirname))
})
59 changes: 59 additions & 0 deletions packages/@tinacms/mdx/src/next/tests/mdx-basic-nested-objects-3/node.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
{
"type": "root",
"children": [
{
"type": "p",
"children": [
{
"type": "text",
"text": "Hello"
}
]
},
{
"type": "mdxJsxFlowElement",
"name": "Table",
"children": [
{
"type": "text",
"text": ""
}
],
"props": {
"rows": [
{
"columns": [
{
"content": {
"type": "root",
"children": [
{
"type": "h1",
"children": [
{
"type": "text",
"text": "Hello "
},
{
"type": "mdxJsxTextElement",
"name": "World",
"children": [
{
"type": "text",
"text": ""
}
],
"props": {}
}
]
}
]
}
}
]
}
]
}
}
]
}
3 changes: 3 additions & 0 deletions packages/@tinacms/mdx/src/next/tests/mdx-basic-nested-objects-3/out.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Hello

<Table rows={[{ columns: [{ content: "# Hello <World />\n" }] }]} />
32 changes: 32 additions & 0 deletions packages/@tinacms/mdx/src/next/tests/mdx-basic-nested-objects/field.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
import { RichTextField } from '@tinacms/schema-tools'

export const field: RichTextField = {
name: 'body',
type: 'rich-text',
parser: { type: 'mdx' },
templates: [
{
name: 'Table',
fields: [
{
name: 'rows',
type: 'object',
list: true,
fields: [
{
name: 'columns',
type: 'object',
list: true,
fields: [
{
name: 'content',
type: 'rich-text',
},
],
},
],
},
],
},
],
}
11 changes: 11 additions & 0 deletions packages/@tinacms/mdx/src/next/tests/mdx-basic-nested-objects/in.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Hello

<Table rows={[
{
columns: [
{
content: "# Hello"
}
]
}
]} />
13 changes: 13 additions & 0 deletions packages/@tinacms/mdx/src/next/tests/mdx-basic-nested-objects/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import { it, expect } from 'vitest'
import { parseMDX } from '../../../parse'
import { stringifyMDX } from '../../../stringify'
import { field } from './field'
import input from './in.md?raw'
import * as util from '../util'

it('matches input', () => {
const tree = parseMDX(input, field, (v) => v)
expect(util.print(tree)).toMatchFile(util.nodePath(__dirname))
const string = stringifyMDX(tree, field, (v) => v)
expect(string).toMatchFile(util.mdPath(__dirname))
})
48 changes: 48 additions & 0 deletions packages/@tinacms/mdx/src/next/tests/mdx-basic-nested-objects/node.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
{
"type": "root",
"children": [
{
"type": "p",
"children": [
{
"type": "text",
"text": "Hello"
}
]
},
{
"type": "mdxJsxFlowElement",
"name": "Table",
"children": [
{
"type": "text",
"text": ""
}
],
"props": {
"rows": [
{
"columns": [
{
"content": {
"type": "root",
"children": [
{
"type": "h1",
"children": [
{
"type": "text",
"text": "Hello"
}
]
}
]
}
}
]
}
]
}
}
]
}
3 changes: 3 additions & 0 deletions packages/@tinacms/mdx/src/next/tests/mdx-basic-nested-objects/out.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
Hello

<Table rows={[{ columns: [{ content: "# Hello\n" }] }]} />