Compiler/Emitter behavior consistency and improvement

[allenjzhang]

Compiler improvements:

• Display emitters being invoked. This is helpful when there are multiple emitters, users will be able to see the progress.
• When multiple emitters run, if one emitter fails, currently compiler skip the rest. We should decide whether we want to change the behavior to run all. If not, minimally should display message telling user we have skipped the rest of xxx emitters.
• When crash happens, write out detailed log including callstack in a temp file instead of showing on console

Consistent behavior among emitters

• Currently C# directly write out to console on files generated while other emitters writes nothing. They should be consistent. We should decide what's the rule and ways to allow emitter/user to see message at different level.
• Proposed rules:
  • When dealing with KNOWN bad states, each emitter should use diagnostic report at the consistent level.
  • For UNKNOWN bad states, they are allow to throw which generates callstacks & display File a bug message.
• Each emitter output same given an empty spec
• Champion scenario specs & common known bad state specs should be checked into Spector http-spec for regression tracking

More to add?

[ArcturusZhang]

Hi @allenjzhang maybe we should also design pages for those known bad states (defined either in compiler/TCGC/language emitters) and put them inside typespec.io or typespec-azure.io about why this happens, how to fix it, examples, etc just like those compiler reported errors in other languages such as this.
In this way, when a user sees the diagnostic warning or error, there is a code that they could search for in our document pages.

To build this page, I would like to propose that we do it through automation inside of writing docs from scratches. Such as those reference docs for our decorators, we write them inside our code as comments, and there is a tool to extract them out as a doc page. We should do the same for those diagnostic error/warning pages.