[Tracking]: Diagnostics

[h-a-n-a]

What subject does this issue tracking?

As time goes by, we have met some problems related to error handling. We want to improve the DX for both ourselves and our users.

Therefore, we plan to refactor the error-handling parts of Rspack in every aspect, these include, for example:

• Better error diagnostics
• Report the "how" and "why" when something breaks
• Report when HMR is broken, it is currently silent

Tasks

Beta Give feedback

1. [Feature Request]: Display better error messages for known file type. #2255
   feat stale +2
   
2. Align ErrorOverlay with webpack #4340
   feat stale team +3
3. Tracking: Align error messages with Webpack #4341
   16 of 16
   stale team +2
4. add version check for binding #3715
   feat feat: DX good first issue team +4
   
5. provide error hint about resolve failed when resolve from esm file #3883
   feat team +2
   
6. Errors in visitors should be handled user error handler #4344
   feat stale team +3
7. better resolve error message #4348
   team +1
8. support hideStack in WebpackError #4326
   team +1
   
9. error[internal]: No such file or directory (os error 2), failed to read #4321
   bug need reproduction +2
   
10. Improve error message when unsupported output.hashFunction method is used #4504
    A-node-api feat good first issue +3
11. Empty dependency (empty request) blocks rebuild #5082
    bug team +2
12. Provide more accurate error prompts when the import path does not exist #4769
    A-resolver feat good first issue +3
    
13. [Tracking]: Hard to debug on context.compiler.watch's errorHandler #5619
    0 of 1
    tracking issue +1
14. [Feature]: improve diagnostic when resolve failed with missing resolve.extensions #5627
    contrib: easy contrib: has guidance feat pr welcome team +5
    
15. [Feature]: support experimental best-effort source-map remapping in module errors #5632
    contrib: medium feat pr welcome stale team +5
16. Support more intuitive CSS diagnostic for ~ as a alias #5986
    contrib: easy good first issue team +3
    
17. [Feature]: better error report of tapable error #6051
    contrib: medium feat pr welcome stale team +5

[hyf0]

Context:

This the current design of error-handling in Rspack: #548.

[hyf0]

We should first design good error data structures both for the rust and js sides, then we could start to improve the error handling on top of those data structures.

[hardfist]

need to add hint support for better error suggestions like webpack/webpack#17122, cc @ScriptedAlchemy

[hardfist]

another thing drive me nuts is that when rspack panic all diagnostics is lost