Skip to content

Commit dae82ae

Browse files
wooormwooorm
committedOct 22, 2023
Refactor some more errors
·
3.1.03.0.0
1 parent 8f3b292 commit dae82ae

File tree

7 files changed

+63
-41
lines changed

7 files changed

+63
-41
lines changed
 

‎package-lock.json

+2-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/esbuild/lib/index.js

+17-14
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
* @typedef {import('esbuild').Plugin} Plugin
88
* @typedef {import('esbuild').PluginBuild} PluginBuild
99
* @typedef {import('vfile').Value} Value
10-
* @typedef {import('vfile-message').VFileMessage} VFileMessage
1110
*/
1211

1312
/**
@@ -68,6 +67,7 @@ import {createFormatAwareProcessors} from '@mdx-js/mdx/internal-create-format-aw
6867
import {extnamesToRegex} from '@mdx-js/mdx/internal-extnames-to-regex'
6968
import {fetch} from 'undici'
7069
import {VFile} from 'vfile'
70+
import {VFileMessage} from 'vfile-message'
7171

7272
const eol = /\r\n|\r|\n|\u2028|\u2029/g
7373

@@ -204,7 +204,7 @@ export function esbuild(options) {
204204
let file = new VFile({path: data.path, value: doc})
205205
/** @type {Value | undefined} */
206206
let value
207-
/** @type {Array<Error | VFileMessage>} */
207+
/** @type {Array<VFileMessage>} */
208208
let messages = []
209209
/** @type {Array<Message>} */
210210
const errors = []
@@ -216,13 +216,21 @@ export function esbuild(options) {
216216
value = file.value
217217
messages = file.messages
218218
} catch (error_) {
219-
const error = /** @type {Error | VFileMessage} */ (error_)
220-
if ('fatal' in error) error.fatal = true
221-
messages.push(error)
219+
const cause = /** @type {VFileMessage | Error} */ (error_)
220+
const message =
221+
'reason' in cause
222+
? cause
223+
: new VFileMessage('Cannot process MDX file with esbuild', {
224+
cause,
225+
ruleId: 'process-error',
226+
source: '@mdx-js/esbuild'
227+
})
228+
message.fatal = true
229+
messages.push(message)
222230
}
223231

224232
for (const message of messages) {
225-
const list = !('fatal' in message) || message.fatal ? errors : warnings
233+
const list = message.fatal ? errors : warnings
226234
list.push(vfileMessageToEsbuild(state, message))
227235
}
228236

@@ -244,13 +252,13 @@ export function esbuild(options) {
244252
/**
245253
* @param {Readonly<State>} state
246254
* Info passed around.
247-
* @param {Readonly<Error | VFileMessage>} message
255+
* @param {Readonly<VFileMessage>} message
248256
* VFile message or error.
249257
* @returns {Message}
250258
* ESBuild message.
251259
*/
252260
function vfileMessageToEsbuild(state, message) {
253-
const place = 'place' in message ? message.place : undefined
261+
const place = message.place
254262
const start = place ? ('start' in place ? place.start : place) : undefined
255263
const end = place && 'end' in place ? place.end : undefined
256264
let length = 0
@@ -288,11 +296,6 @@ function vfileMessageToEsbuild(state, message) {
288296
},
289297
notes: [],
290298
pluginName: state.name,
291-
text: String(
292-
('reason' in message ? message.reason : undefined) ||
293-
/* c8 ignore next 2 - errors should have stacks */
294-
message.stack ||
295-
message
296-
)
299+
text: message.reason
297300
}
298301
}

‎packages/esbuild/package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@
4040
"@mdx-js/mdx": "^2.0.0",
4141
"@types/unist": "^3.0.0",
4242
"undici": "^5.0.0",
43-
"vfile": "^6.0.0"
43+
"vfile": "^6.0.0",
44+
"vfile-message": "^4.0.0"
4445
},
4546
"peerDependencies": {
4647
"esbuild": ">=0.14.0"

‎packages/esbuild/test/index.js

+13-9
Original file line numberDiff line numberDiff line change
@@ -427,7 +427,7 @@ test('@mdx-js/esbuild', async function (t) {
427427
}
428428
})
429429

430-
await t.test('should pass errors (2)', async function () {
430+
await t.test('should pass errors', async function () {
431431
const mdxUrl = new URL('esbuild.mdx', import.meta.url)
432432
const jsUrl = new URL('esbuild.js', import.meta.url)
433433

@@ -439,11 +439,7 @@ test('@mdx-js/esbuild', async function (t) {
439439
entryPoints: [fileURLToPath(mdxUrl)],
440440
outfile: fileURLToPath(jsUrl),
441441
format: 'esm',
442-
plugins: [
443-
esbuildMdx({
444-
rehypePlugins: [crash]
445-
})
446-
]
442+
plugins: [esbuildMdx({rehypePlugins: [crash]})]
447443
})
448444
assert.fail()
449445
} catch (error) {
@@ -457,7 +453,16 @@ test('@mdx-js/esbuild', async function (t) {
457453
assert.deepEqual(result, {
458454
errors: [
459455
{
460-
detail: {},
456+
detail: {
457+
cause: {},
458+
fatal: true,
459+
message: 'Cannot process MDX file with esbuild',
460+
name: '1:1',
461+
reason: 'Cannot process MDX file with esbuild',
462+
ruleId: 'process-error',
463+
source: '@mdx-js/esbuild'
464+
},
465+
id: '',
461466
location: {
462467
column: 0,
463468
file: 'test/esbuild.mdx',
@@ -469,8 +474,7 @@ test('@mdx-js/esbuild', async function (t) {
469474
},
470475
notes: [],
471476
pluginName: '@mdx-js/esbuild',
472-
text: 'Error: Something went wrong',
473-
id: ''
477+
text: 'Cannot process MDX file with esbuild'
474478
}
475479
],
476480
warnings: []

‎packages/mdx/lib/plugin/recma-document.js

+22-9
Original file line numberDiff line numberDiff line change
@@ -134,11 +134,15 @@ export function recmaDocument(options) {
134134
if (child.type === 'ExportDefaultDeclaration') {
135135
if (layout) {
136136
file.fail(
137-
'Cannot specify multiple layouts (previous: ' +
137+
'Unexpected duplicate layout, expected a single layout (previous: ' +
138138
stringifyPosition(positionFromEstree(layout)) +
139139
')',
140-
positionFromEstree(child),
141-
'recma-document:duplicate-layout'
140+
{
141+
ancestors: [tree, child],
142+
place: positionFromEstree(child),
143+
ruleId: 'duplicate-layout',
144+
source: 'recma-document'
145+
}
142146
)
143147
}
144148

@@ -169,11 +173,15 @@ export function recmaDocument(options) {
169173
if (specifier.exported.name === 'default') {
170174
if (layout) {
171175
file.fail(
172-
'Cannot specify multiple layouts (previous: ' +
176+
'Unexpected duplicate layout, expected a single layout (previous: ' +
173177
stringifyPosition(positionFromEstree(layout)) +
174178
')',
175-
positionFromEstree(child),
176-
'recma-document:duplicate-layout'
179+
{
180+
ancestors: [tree, child, specifier],
181+
place: positionFromEstree(child),
182+
ruleId: 'duplicate-layout',
183+
source: 'recma-document'
184+
}
177185
)
178186
}
179187

@@ -413,9 +421,14 @@ export function recmaDocument(options) {
413421
) {
414422
if (!useDynamicImport) {
415423
file.fail(
416-
'Cannot use `import` or `export … from` in `evaluate` (outputting a function body) by default: please set `useDynamicImport: true` (and probably specify a `baseUrl`)',
417-
positionFromEstree(node),
418-
'recma-document:invalid-esm-statement'
424+
'Unexpected `import` or `export … from` in `evaluate` (outputting a function body) by default: please set `useDynamicImport: true` (and probably specify a `baseUrl`)',
425+
{
426+
// Results of this function end up in `tree` again.
427+
ancestors: [tree, node],
428+
place: positionFromEstree(node),
429+
ruleId: 'invalid-esm-statement',
430+
source: 'recma-document'
431+
}
419432
)
420433
}
421434

‎packages/mdx/test/compile.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -604,7 +604,7 @@ test('@mdx-js/mdx: compile', async function (t) {
604604
} catch (error) {
605605
assert.match(
606606
String(error),
607-
/Cannot specify multiple layouts \(previous: 1:1-1:31\)/
607+
/Unexpected duplicate layout, expected a single layout \(previous: 1:1-1:31\)/
608608
)
609609
}
610610
})
@@ -618,7 +618,7 @@ test('@mdx-js/mdx: compile', async function (t) {
618618
} catch (error) {
619619
assert.match(
620620
String(error),
621-
/Cannot specify multiple layouts \(previous: 1:1-1:31\)/
621+
/Unexpected duplicate layout, expected a single layout \(previous: 1:1-1:31\)/
622622
)
623623
}
624624
})

‎packages/mdx/test/evaluate.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -247,14 +247,14 @@ test('@mdx-js/mdx: evaluate', async function (t) {
247247
)
248248
})
249249

250-
await t.test('should throw on an export from', async function () {
250+
await t.test('should throw on an `export * from`', async function () {
251251
try {
252252
await evaluate('export {a} from "b"', runtime)
253253
assert.fail()
254254
} catch (error) {
255255
assert.match(
256256
String(error),
257-
/Cannot use `import` or `export … from` in `evaluate` \(outputting a function body\) by default/
257+
/Unexpected `import` or `export … from` in `evaluate` \(outputting a function body\) by default/
258258
)
259259
}
260260
})
@@ -379,7 +379,7 @@ test('@mdx-js/mdx: evaluate', async function (t) {
379379
} catch (error) {
380380
assert.match(
381381
String(error),
382-
/Cannot use `import` or `export … from` in `evaluate` \(outputting a function body\) by default/
382+
/Unexpected `import` or `export … from` in `evaluate` \(outputting a function body\) by default/
383383
)
384384
}
385385
})
@@ -391,7 +391,7 @@ test('@mdx-js/mdx: evaluate', async function (t) {
391391
} catch (error) {
392392
assert.match(
393393
String(error),
394-
/Cannot use `import` or `export … from` in `evaluate` \(outputting a function body\) by default/
394+
/Unexpected `import` or `export … from` in `evaluate` \(outputting a function body\) by default/
395395
)
396396
}
397397
})
@@ -403,7 +403,7 @@ test('@mdx-js/mdx: evaluate', async function (t) {
403403
} catch (error) {
404404
assert.match(
405405
String(error),
406-
/Cannot use `import` or `export … from` in `evaluate` \(outputting a function body\) by default/
406+
/Unexpected `import` or `export … from` in `evaluate` \(outputting a function body\) by default:/
407407
)
408408
}
409409
})

1 commit comments

Comments
 (1)

vercel[bot] commented on Oct 22, 2023

@vercel[bot]
vercel[bot]
on Oct 22, 2023

Successfully deployed to the following URLs:

mdx – ./

mdx-mdx.vercel.app
mdx-git-main-mdx.vercel.app
mdxjs.com
v2.mdxjs.com

Please sign in to comment.