mirror of
https://github.com/vercel/next.js.git
synced 2026-09-20 02:25:18 +08:00
Tobias Koppers
1287f9a027
### What?
Changes Turbopack's error overlay to show specific SWC diagnostic
messages as the error title instead of generic messages like "Parsing
ecmascript source code failed" or "Ecmascript file had an error".
### Why?
Previously, all SWC parse/analysis errors in Turbopack showed a generic
title (e.g. "Parsing ecmascript source code failed") in the redbox
header, with the actual specific error message buried in the description
below the code frame. This made it harder for developers to quickly
understand what went wrong.
**Before:**
```
Parsing ecmascript source code failed
> 1 | export default () => <div/
| ^
Expected '>', got '<eof>'
```
**After:**
```
Expected '>', got '<eof>'
> 1 | export default () => <div/
| ^
Parsing ecmascript source code failed
```
### How?
**Core change** in
`turbopack/crates/turbopack-swc-utils/src/emitter.rs`:
When the `IssueEmitter` has a `self.title` set (the generic title like
"Parsing ecmascript source code failed"), the SWC diagnostic message is
now used as the issue title, and the generic title is demoted to the
description. When `self.title` is not set, the existing behavior is
preserved (first line of message becomes title, rest becomes
description).
**Test updates** across ~15 test files:
Updated all `isTurbopack` branches in test expectations to reflect the
swapped title/description. Only Turbopack-specific branches were
modified; webpack and rspack expectations are unchanged.
**New test suite** (`test/development/app-dir/ecmascript-error-title/`):
Dedicated tests verifying that both syntax errors (e.g. `Expected '>',
got '<eof>'`) and analysis errors (e.g. `the name 'Table' is defined
multiple times`) show the specific SWC message as the redbox title.
**Turbopack snapshot updates:**
4 snapshot files renamed to reflect new titles (e.g. `Parsing ecmascript
source code failed-*.txt` → `Expression expected-*.txt`).
---------
Co-authored-by: Claude <noreply@anthropic.com>
67 lines
2.0 KiB
TypeScript
67 lines
2.0 KiB
TypeScript
import { nextTestSetup } from 'e2e-utils'
|
|
import {
|
|
getRedboxDescription,
|
|
getRedboxSource,
|
|
waitForRedbox,
|
|
} from 'next-test-utils'
|
|
import { outdent } from 'outdent'
|
|
|
|
describe('ecmascript-error-title', () => {
|
|
const { next, isTurbopack } = nextTestSetup({
|
|
files: __dirname,
|
|
})
|
|
|
|
it('should show the specific SWC error message as title for syntax errors', async () => {
|
|
const browser = await next.browser('/')
|
|
expect(await browser.elementByCss('p').text()).toBe('hello world')
|
|
|
|
await next.patchFile(
|
|
'app/page.tsx',
|
|
outdent`
|
|
export default () => <div/
|
|
`
|
|
)
|
|
|
|
if (isTurbopack) {
|
|
// The redbox description should show the specific SWC error message
|
|
// instead of the generic "Parsing ecmascript source code failed".
|
|
await waitForRedbox(browser)
|
|
const description = await getRedboxDescription(browser)
|
|
expect(description).toBe("Expected '>', got '<eof>'")
|
|
|
|
const source = await getRedboxSource(browser)
|
|
expect(source).toContain("Expected '>', got '<eof>'")
|
|
expect(source).toContain('> 1 | export default () => <div/')
|
|
}
|
|
})
|
|
|
|
it('should show the specific SWC error message as title for analysis errors', async () => {
|
|
const browser = await next.browser('/')
|
|
|
|
await next.patchFile(
|
|
'app/page.tsx',
|
|
outdent`
|
|
import { Table } from './table'
|
|
export default function Page() {
|
|
return <Table />
|
|
}
|
|
export function Table() {
|
|
return <p>hello</p>
|
|
}
|
|
`
|
|
)
|
|
|
|
if (isTurbopack) {
|
|
// The redbox description should show the specific SWC error message
|
|
// instead of the generic "Ecmascript file had an error".
|
|
await waitForRedbox(browser)
|
|
const description = await getRedboxDescription(browser)
|
|
expect(description).toBe('the name `Table` is defined multiple times')
|
|
|
|
const source = await getRedboxSource(browser)
|
|
expect(source).toContain('the name `Table` is defined multiple times')
|
|
expect(source).toContain('> 5 | export function Table() {')
|
|
}
|
|
})
|
|
})
|