forked from nuxt-modules/mdc
-
Notifications
You must be signed in to change notification settings - Fork 0
/
module.ts
272 lines (243 loc) · 7.85 KB
/
module.ts
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
import { defineNuxtModule, extendViteConfig, addComponent, addComponentsDir, createResolver, addServerHandler, addTemplate, addImports, addServerImports, installModule } from '@nuxt/kit'
import fs from 'fs'
import type { ModuleOptions } from './types'
import { defu } from 'defu'
import { registerMDCSlotTransformer } from './utils/vue-mdc-slot'
import { resolve } from 'pathe'
import type { BundledLanguage } from 'shiki'
import * as templates from './templates'
export const DefaultHighlightLangs: BundledLanguage[] = [
'js',
'jsx',
'json',
'ts',
'tsx',
'vue',
'css',
'html',
'vue',
'bash',
'md',
'mdc',
'yaml'
]
export default defineNuxtModule<ModuleOptions>({
meta: {
name: '@nuxtjs/mdc',
configKey: 'mdc'
},
// Default configuration options of the Nuxt module
defaults: {
remarkPlugins: {},
rehypePlugins: {},
highlight: false,
headings: {
anchorLinks: {
h1: false,
h2: true,
h3: true,
h4: true,
h5: false,
h6: false
}
},
keepComments: false,
components: {
prose: true,
map: {}
},
},
async setup(options, nuxt) {
resolveOptions(options)
const resolver = createResolver(import.meta.url)
nuxt.options.runtimeConfig.public.mdc = defu(nuxt.options.runtimeConfig.public.mdc, {
components: {
prose: options.components!.prose!,
map: options.components!.map!
},
headings: options.headings!
})
if (options.highlight) {
// Install nuxt-shiki
// @see https://github.com/pi0/nuxt-shiki#nuxt-shiki
installModule('nuxt-shiki', {
bundledThemes: options.highlight.themes,
bundledLangs: options.highlight.langs,
defaultTheme: options.highlight.theme,
})
// Add server handlers
addServerHandler({
route: '/api/_mdc/highlight',
handler: resolver.resolve('./runtime/highlighter/event-handler')
})
options.rehypePlugins ||= {}
options.rehypePlugins.highlight ||= {}
options.rehypePlugins.highlight.src ||= await resolver.resolvePath('./runtime/highlighter/rehype-nuxt')
options.rehypePlugins.highlight.options ||= {}
}
const registerTemplate: typeof addTemplate = (options) => {
const name = (options as any).filename.replace(/\.m?js$/, '')
const alias = '#' + name
const results = addTemplate({
...options as any,
write: true, // Write to disk for Nitro to consume
})
nuxt.options.nitro.alias ||= {}
nuxt.options.nitro.externals ||= {}
nuxt.options.nitro.externals.inline ||= []
nuxt.options.alias[alias] = results.dst
nuxt.options.nitro.alias[alias] = nuxt.options.alias[alias]
nuxt.options.nitro.externals.inline.push(nuxt.options.alias[alias])
nuxt.options.nitro.externals.inline.push(alias)
return results as any
}
// mdc.config.ts support
const mdcConfigs: string[] = []
for (const layer of nuxt.options._layers) {
let path = resolve(layer.config.srcDir, 'mdc.config.ts')
if (fs.existsSync(path)) {
mdcConfigs.push(path)
}
else {
path = resolve(layer.config.srcDir, 'mdc.config.js')
if (fs.existsSync(path)) {
mdcConfigs.push(path)
}
}
}
await nuxt.callHook('mdc:configSources', mdcConfigs)
registerTemplate({
filename: 'mdc-configs.mjs',
getContents: templates.mdcConfigs,
options: { configs: mdcConfigs },
})
// Add highlighter
registerTemplate({
filename: 'mdc-highlighter.mjs',
getContents: templates.mdcHighlighter,
options: {
shikiPath: resolver.resolve('../dist/runtime/highlighter/shiki'),
options: options.highlight,
// When WASM support enabled in Nitro, we could use the .wasm file directly for Cloudflare Workers
useWasmAssets: !nuxt.options.dev && !!nuxt.options.nitro.experimental?.wasm
},
})
// Add imports template
registerTemplate({
filename: 'mdc-imports.mjs',
getContents: templates.mdcImports,
options,
})
// Add components
addComponent({ name: 'MDC', filePath: resolver.resolve('./runtime/components/MDC') })
addComponent({ name: 'MDCRenderer', filePath: resolver.resolve('./runtime/components/MDCRenderer') })
addComponent({ name: 'MDCSlot', filePath: resolver.resolve('./runtime/components/MDCSlot') })
// Add composables
addImports({ from: resolver.resolve('./runtime/utils/node'), name: 'flatUnwrap', as: 'unwrapSlot' })
// Add parser
addImports({ from: resolver.resolve('./runtime/parser'), name: 'parseMarkdown', as: 'parseMarkdown' })
addServerImports([{ from: resolver.resolve('./runtime/parser'), name: 'parseMarkdown', as: 'parseMarkdown' }])
// Register prose components
if (options.components?.prose) {
addComponentsDir({
path: resolver.resolve('./runtime/components/prose'),
pathPrefix: false,
prefix: '',
global: true
})
}
// Update Vite optimizeDeps
extendViteConfig((config) => {
const include = [
'remark-gfm', // from runtime/parser/index.ts
'remark-emoji', // from runtime/parser/index.ts
'remark-mdc', // from runtime/parser/index.ts
'remark-rehype', // from runtime/parser/index.ts
'rehype-raw', // from runtime/parser/index.ts
'parse5', // transitive deps of rehype
'unist-util-visit', // from runtime/highlighter/rehype.ts
'unified', // deps by all the plugins
'debug', // deps by many libraries but it's not an ESM
]
const exclude = [
'@nuxtjs/mdc' // package itself, it's a build time module
]
config.optimizeDeps ||= {}
config.optimizeDeps.exclude ||= []
config.optimizeDeps.include ||= []
for (const pkg of include) {
if (!config.optimizeDeps.include.includes(pkg)) {
config.optimizeDeps.include.push('@nuxtjs/mdc > ' + pkg)
}
}
for (const pkg of exclude) {
if (!config.optimizeDeps.exclude.includes(pkg)) {
config.optimizeDeps.exclude.push(pkg)
}
}
})
// Register user global components
const _layers = [...nuxt.options._layers].reverse()
for (const layer of _layers) {
const srcDir = layer.config.srcDir
const globalComponents = resolver.resolve(srcDir, 'components/mdc')
const dirStat = await fs.promises.stat(globalComponents).catch(() => null)
if (dirStat && dirStat.isDirectory()) {
nuxt.hook('components:dirs', (dirs: any[]) => {
dirs.unshift({
path: globalComponents,
global: true,
pathPrefix: false,
prefix: ''
})
})
}
}
registerMDCSlotTransformer(resolver)
}
})
function resolveOptions(options: ModuleOptions) {
if (options.highlight !== false) {
options.highlight ||= {}
options.highlight.highlighter ||= 'shiki'
options.highlight.theme ||= {
default: 'github-light',
dark: 'github-dark'
}
options.highlight.themes = [
...(options.highlight.themes || []),
...Object.values(options.highlight.theme) as any
]
options.highlight.langs ||= DefaultHighlightLangs
if (options.highlight.preload) {
options.highlight.langs.push(...options.highlight.preload as any || [])
}
}
}
declare module '@nuxt/schema' {
interface NuxtHooks {
'mdc:configSources': (configs: string[]) => void
}
interface PublicRuntimeConfig {
mdc: {
components: {
prose: boolean
map: Record<string, string>
}
headings: ModuleOptions['headings']
}
}
interface ConfigSchema {
runtimeConfig: {
public?: {
mdc: {
components: {
prose: boolean
map: Record<string, string>
}
}
headings: ModuleOptions['headings']
}
}
}
}