Skip to content

Improve block parsing for alphanumeric component names #604

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

Merged
merged 5 commits into from
Jul 12, 2019
Merged

Improve block parsing for alphanumeric component names #604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
604dad7
Improve block parsing for alphanumeric component names
johno Jun 17, 2019
71a58fa
Add more test cases
johno Jul 12, 2019
c039a81
Add more test cases, make block parsing more flexible
johno Jul 12, 2019
1c01115
Add missing fragment test
johno Jul 12, 2019
0dd302e
Undo change that's no longer needed
johno Jul 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion packages/remark-mdx/block.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,15 @@ const cdataOpenExpression = /^<!\[CDATA\[/
const cdataCloseExpression = /\]\]>/
const elementCloseExpression = /^$/
const otherElementOpenExpression = new RegExp(openCloseTag.source + '\\s*$')
const fragmentOpenExpression = /^<>/

function blockHtml(eat, value, silent) {
const blocks = '[a-z\\.]+(\\.){0,1}[a-z\\.]'
const blocks = '[a-z\\.]*(\\.){0,1}[a-z][a-z0-9\\.]*'
const elementOpenExpression = new RegExp(
'^</?(' + blocks + ')(?=(\\s|/?>|$))',
'i'
)

const length = value.length
let index = 0
let next
Expand All @@ -48,6 +50,7 @@ function blockHtml(eat, value, silent) {
[directiveOpenExpression, directiveCloseExpression, true],
[cdataOpenExpression, cdataCloseExpression, true],
[elementOpenExpression, elementCloseExpression, true],
[fragmentOpenExpression, elementCloseExpression, true],
[otherElementOpenExpression, elementCloseExpression, false]
]

Expand Down
110 changes: 108 additions & 2 deletions packages/remark-mdx/test/__snapshots__/test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ const makeShortcode = name => function MDXDefaultShortcode(props) {
return <div {...props}/>
};
const Baz = makeShortcode(\\"Baz\\");
const Paragraph = makeShortcode(\\"Paragraph\\");
const Button = makeShortcode(\\"Button\\");
const layoutProps = {

};
Expand All @@ -28,6 +30,15 @@ export default function MDXContent({
<Baz mdxType=\\"Baz\\">
Hi!
</Baz>
<Paragraph bg='red.500' color='white' mdxType=\\"Paragraph\\">Foo</Paragraph>
<Button mdxType=\\"Button\\">
Hi!
</Button>
<>Foo</>
<>
Foo
</>
<h1>Hello, world!</h1>
</MDXLayout>;
}

Expand Down Expand Up @@ -171,12 +182,107 @@ Object {
Hi!
</Baz>",
},
Object {
"position": Position {
"end": Object {
"column": 54,
"line": 12,
"offset": 192,
},
"indent": Array [],
"start": Object {
"column": 1,
"line": 12,
"offset": 139,
},
},
"type": "jsx",
"value": "<Paragraph bg='red.500' color='white'>Foo</Paragraph>",
},
Object {
"position": Position {
"end": Object {
"column": 10,
"line": 16,
"offset": 218,
},
"indent": Array [
1,
1,
],
"start": Object {
"column": 1,
"line": 14,
"offset": 194,
},
},
"type": "jsx",
"value": "<Button>
Hi!
</Button>",
},
Object {
"position": Position {
"end": Object {
"column": 9,
"line": 18,
"offset": 228,
},
"indent": Array [],
"start": Object {
"column": 1,
"line": 18,
"offset": 220,
},
},
"type": "jsx",
"value": "<>Foo</>",
},
Object {
"position": Position {
"end": Object {
"column": 4,
"line": 22,
"offset": 242,
},
"indent": Array [
1,
1,
],
"start": Object {
"column": 1,
"line": 20,
"offset": 230,
},
},
"type": "jsx",
"value": "<>
Foo
</>",
},
Object {
"position": Position {
"end": Object {
"column": 23,
"line": 24,
"offset": 266,
},
"indent": Array [],
"start": Object {
"column": 1,
"line": 24,
"offset": 244,
},
},
"type": "jsx",
"value": "<h1>Hello, world!</h1>",
},
],
"position": Object {
"end": Object {
"column": 1,
"line": 11,
"offset": 138,
"line": 25,
"offset": 267,
},
"start": Object {
"column": 1,
Expand Down
24 changes: 24 additions & 0 deletions packages/remark-mdx/test/test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,20 @@ export default Foo
<Baz>
Hi!
</Baz>

<Paragraph bg='red.500' color='white'>Foo</Paragraph>

<Button>
Hi!
</Button>

<>Foo</>

<>
Foo
</>

<h1>Hello, world!</h1>
`

// Manually apply all mdx transformations for now
Expand Down Expand Up @@ -65,6 +79,16 @@ it('maintains the proper positional info', () => {
expect(result).toMatchSnapshot()
})

it('does not wrap an block level elements in a paragraph', () => {
const result = transpile(FIXTURE)

expect(result).not.toMatch(/<p><Baz/)
expect(result).not.toMatch(/<p><Button/)
expect(result).not.toMatch(/<p><Paragraph>/)
expect(result).not.toMatch(/<p><>/)
expect(result).not.toMatch(/<p><h1/)
})

it('removes newlines between imports and exports', () => {
const fixture = [
'import Foo1 from "./foo"',
Expand Down