-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
index.js
201 lines (182 loc) · 5.38 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
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
/**
* @typedef {import('@mdx-js/mdx').CompileOptions} CompileOptions
* @typedef {import('esbuild').Message} Message
* @typedef {import('esbuild').OnLoadArgs} OnLoadArgs
* @typedef {import('esbuild').OnLoadResult} OnLoadResult
* @typedef {import('esbuild').OnResolveArgs} OnResolveArgs
* @typedef {import('esbuild').Plugin} Plugin
* @typedef {import('esbuild').PluginBuild} PluginBuild
* @typedef {import('vfile').Value} Value
*/
/**
* @typedef {Omit<OnLoadArgs, 'pluginData'> & LoadDataFields} LoadData
* Data passed to `onload`.
*
* @typedef LoadDataFields
* Extra fields given in `data` to `onload`.
* @property {PluginData | null | undefined} [pluginData]
* Plugin data.
*
* @typedef {CompileOptions} Options
* Configuration.
*
* Options are the same as `compile` from `@mdx-js/mdx`.
*
* @typedef PluginData
* Extra data passed.
* @property {Buffer | string | null | undefined} [contents]
* File contents.
*
* @typedef State
* Info passed around.
* @property {string} doc
* File value.
* @property {string} name
* Plugin name.
* @property {string} path
* File path.
*/
import assert from 'node:assert'
import fs from 'node:fs/promises'
import path from 'node:path'
import {createFormatAwareProcessors} from '@mdx-js/mdx/internal-create-format-aware-processors'
import {extnamesToRegex} from '@mdx-js/mdx/internal-extnames-to-regex'
import {SourceMapGenerator} from 'source-map'
import {VFile} from 'vfile'
import {VFileMessage} from 'vfile-message'
const eol = /\r\n|\r|\n|\u2028|\u2029/g
const name = '@mdx-js/esbuild'
/**
* Create an esbuild plugin to compile MDX to JS.
*
* esbuild takes care of turning modern JavaScript features into syntax that
* works wherever you want it to.
* With other integrations you might need to use Babel for this, but with
* esbuild that’s not needed.
* See esbuild’s docs for more info.
*
* @param {Readonly<Options> | null | undefined} [options]
* Configuration (optional).
* @return {Plugin}
* Plugin.
*/
export function esbuild(options) {
const {extnames, process} = createFormatAwareProcessors({
...options,
SourceMapGenerator
})
return {name, setup}
/**
* @param {PluginBuild} build
* Build.
* @returns {undefined}
* Nothing.
*/
function setup(build) {
build.onLoad({filter: extnamesToRegex(extnames)}, onload)
/**
* @param {LoadData} data
* Data.
* @returns {Promise<OnLoadResult>}
* Result.
*/
async function onload(data) {
const document = String(
data.pluginData &&
data.pluginData.contents !== null &&
data.pluginData.contents !== undefined
? data.pluginData.contents
: await fs.readFile(data.path)
)
/** @type {State} */
const state = {doc: document, name, path: data.path}
let file = new VFile({path: data.path, value: document})
/** @type {string | undefined} */
let value
/** @type {Array<VFileMessage>} */
let messages = []
/** @type {Array<Message>} */
const errors = []
/** @type {Array<Message>} */
const warnings = []
try {
file = await process(file)
value =
String(file.value) +
'\n//# sourceMappingURL=data:application/json;base64,' +
Buffer.from(JSON.stringify(file.map)).toString('base64') +
'\n'
messages = file.messages
} catch (error_) {
const cause = /** @type {VFileMessage | Error} */ (error_)
const message =
'reason' in cause
? cause
: new VFileMessage('Cannot process MDX file with esbuild', {
cause,
ruleId: 'process-error',
source: '@mdx-js/esbuild'
})
message.fatal = true
messages.push(message)
}
for (const message of messages) {
const list = message.fatal ? errors : warnings
list.push(vfileMessageToEsbuild(state, message))
}
// Safety check: the file has a path, so there has to be a `dirname`.
assert(file.dirname, 'expected `dirname` to be defined')
return {
contents: value || '',
errors,
resolveDir: path.resolve(file.cwd, file.dirname),
warnings
}
}
}
}
/**
* @param {Readonly<State>} state
* Info passed around.
* @param {Readonly<VFileMessage>} message
* VFile message or error.
* @returns {Message}
* ESBuild message.
*/
function vfileMessageToEsbuild(state, message) {
const place = message.place
const start = place ? ('start' in place ? place.start : place) : undefined
const end = place && 'end' in place ? place.end : undefined
let length = 0
let lineStart = 0
let line = 0
let column = 0
if (start && start.offset !== undefined) {
line = start.line
column = start.column - 1
lineStart = start.offset - column
length = 1
if (end && end.offset !== undefined) {
length = end.offset - start.offset
}
}
eol.lastIndex = lineStart
const match = eol.exec(state.doc)
const lineEnd = match ? match.index : state.doc.length
return {
detail: message,
id: '',
location: {
column,
file: state.path,
length: Math.min(length, lineEnd),
line,
lineText: state.doc.slice(lineStart, lineEnd),
namespace: 'file',
suggestion: ''
},
notes: [],
pluginName: state.name,
text: message.reason
}
}