/
index.js
148 lines (128 loc) · 3.84 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/**
* @typedef {import('mdx/types.js').MDXModule} MDXModule
* @typedef {import('vue').Component} AnyComponent
*/
import assert from 'node:assert/strict'
import test from 'node:test'
import {compile, run} from '@mdx-js/mdx'
import {MDXProvider, useMDXComponents} from '@mdx-js/vue'
import * as runtime from 'vue/jsx-runtime'
import * as vue from 'vue'
// Note: a regular import would be nice but that completely messes up the JSX types.
const name = '@vue/server-renderer'
/** @type {{default: {renderToString(node: unknown): string}}} */
const {default: serverRenderer} = await import(name)
test('@mdx-js/vue', async function (t) {
await t.test('should expose the public api', async function () {
assert.deepEqual(Object.keys(await import('@mdx-js/vue')).sort(), [
'MDXProvider',
'useMDXComponents'
])
})
await t.test('should evaluate MDX code', async function () {
const {default: Content} = await evaluate('# hi')
assert.equal(await vueToString(Content), '<h1>hi</h1>')
})
await t.test(
'should evaluate some more complex MDX code (text, inline)',
async function () {
const {default: Content} = await evaluate(
'*a* **b** `c` <abbr title="Markdown + JSX">MDX</abbr>'
)
assert.equal(
await vueToString(Content),
'<p><em>a</em> <strong>b</strong> <code>c</code> <abbr title="Markdown + JSX">MDX</abbr></p>'
)
}
)
await t.test(
'should support Vue components defined in MDX',
async function () {
const {default: Content} = await evaluate(
'export const A = {render() { return <b>!</b> }}\n\n<A />'
)
assert.equal(await vueToString(Content), '<b>!</b>')
}
)
await t.test('should support passing `components`', async function () {
const {default: Content} = await evaluate('# hi')
assert.equal(
await vueToString(Content, {components: {h1: 'h2'}}),
'<h2>hi</h2>'
)
})
await t.test('should support passing `components`', async function () {
const {default: Content} = await evaluate('# hi')
assert.equal(
await vueToString(Content, {components: {h1: 'h2'}}),
'<h2>hi</h2>'
)
})
await t.test('should support `MDXProvider`', async function () {
const {default: Content} = await evaluate('# hi')
assert.equal(
await vueToString({
components: {Content, MDXProvider},
data() {
return {components: {h1: 'h2'}}
},
template:
'<MDXProvider v-bind:components="components"><Content /></MDXProvider>'
}),
'<h2>hi</h2>'
)
})
await t.test(
'should support the MDX provider w/o components',
async function () {
const {default: Content} = await evaluate('# hi')
assert.equal(
await vueToString({
components: {Content, MDXProvider},
template: '<MDXProvider><Content /></MDXProvider>'
}),
'<h1>hi</h1>'
)
}
)
await t.test(
'should support the MDX provider w/o content',
async function () {
assert.equal(
await vueToString({
components: {MDXProvider},
template: '<MDXProvider />'
}),
''
)
}
)
})
/**
* @param {string} value
* MDX.
* @returns {Promise<MDXModule>}
* Module.
*/
async function evaluate(value) {
const file = await compile(value, {
outputFormat: 'function-body',
providerImportSource: '#'
})
return run(file, {...runtime, useMDXComponents})
}
/**
* @param {AnyComponent} root
* Component.
* @param {Record<string, unknown> | null | undefined} [rootProperties]
* Props.
* @returns {Promise<string>}
* HTML.
*/
async function vueToString(root, rootProperties) {
const result = await serverRenderer.renderToString(
vue.createSSRApp(root, rootProperties)
)
// Remove SSR comments used to hydrate.
return result.replaceAll(/<!--[[\]]-->/g, '')
}