Show filename when parse fail

[clinyong]

Q	A
Fixed Issues?	No
Patch: Bug Fix?	No
Major: Breaking Change?	No
Minor: New Feature?	No
Tests Added + Pass?	Yes
Documentation PR Link	No
Any Dependency Changes?	No
License	MIT

[babel-bot]

Build successful! You can test your changes in the REPL here: https://babeljs.io/repl/build/55306/

[nicolo-ribaudo]

Can you show a before/after comparison?

[xtuc]

@nicolo-ribaudo I think that means we have no tests for it.
@clinyong would you mind adding tests for it?

[clinyong]

@nicolo-ribaudo An small reproducible example

const babelParser = require('@babel/parser')

babelParser.parse('const t: any = null')
// with filename
// babelParser.parse('const t: any = null', {sourceFilename: 'path/to/input-file.js'})

before

SyntaxError: Unexpected token (1:7)
    at Parser.raise (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:3833:17)
    at Parser.unexpected (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:5145:16)
    at Parser.parseVar (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7888:18)
    at Parser.parseVarStatement (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7713:10)
    at Parser.parseStatementContent (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7309:21)
    at Parser.parseStatement (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7250:17)
    at Parser.parseBlockOrModuleBlockBody (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7814:25)
    at Parser.parseBlockBody (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7801:10)
    at Parser.parseTopLevel (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7183:10)
    at Parser.parse (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:8662:17)

after (same with before)

SyntaxError: Unexpected token (1:7)
    at Parser.raise (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:3833:17)
    at Parser.unexpected (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:5145:16)
    at Parser.parseVar (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7888:18)
    at Parser.parseVarStatement (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7713:10)
    at Parser.parseStatementContent (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7309:21)
    at Parser.parseStatement (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7250:17)
    at Parser.parseBlockOrModuleBlockBody (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7814:25)
    at Parser.parseBlockBody (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7801:10)
    at Parser.parseTopLevel (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7183:10)
    at Parser.parse (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:8662:17)

after with filename

- SyntaxError: Unexpected token (1:7)
+ SyntaxError: Unexpected token (path/to/input-file.js:1:7)
    at Parser.raise (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:3833:17)
    at Parser.unexpected (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:5145:16)
    at Parser.parseVar (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7888:18)
    at Parser.parseVarStatement (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7713:10)
    at Parser.parseStatementContent (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7309:21)
    at Parser.parseStatement (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7250:17)
    at Parser.parseBlockOrModuleBlockBody (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7814:25)
    at Parser.parseBlockBody (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7801:10)
    at Parser.parseTopLevel (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:7183:10)
    at Parser.parse (/Users/Leo/workfile/ts-demo/node_modules/@babel/parser/lib/index.js:8662:17)

@xtuc test case is added.

[loganfsmyth]

Babel itself already does this in

babel/packages/babel-core/src/transformation/normalize-file.js

Line 152 in 2fb1f9a

err.message = `${filename}: ${err.message}\n\n` + codeFrame;

so I'd be hesitant to land this because it will double up the name.

[clinyong]

@loganfsmyth Can we remove the filename from babel-core? By now it is hard to find out which file parse fail when using babel parser.

[loganfsmyth]

The issue is that users on older versions of @babel/core might still pull in newer versions of the parser, so even if we change core too, users of the older versions would see doubled-up names.

If we make this change, it'd probably need to be toggled with an off-by-default option.

[clinyong]

@loganfsmyth You are right. And should we make this change? I means is it better to show fail filename here. If it is, I can add the option to @babel/parser as you said.

[nicolo-ribaudo]

This seems nice to have, so that I get proper <filename>:<line>:<column> in errors in my terminal and my editor supports clicking on that filepath and brings me to the correct line in the correct file.

@JLHwung @liuxingbaoyu Given #9509 (comment), wdyt about doing this for Babel 8?

[nicolo-ribaudo]

CI failure should be fixed by #15884.