MSBuild TerminalLogger keeps users informed about their build and delights new users

[baronfel]

The LiveLogger is an exciting new feature that MSBuild team has planned for .NET 8. Originally spearheaded by @edvilme, the LiveLogger is intended to be a live-updating, data-heavy view of what is happening in your build right now, using features present in modern terminals to help declutter and organize build results. The goal for this logger is to become the new default experience for all interactive build sessions started by the .NET CLI!

This issue will serve as a centralized way to check on the status of the LiveLogger feature.

Release plan

We are aiming for an initial 'give it a try', opt-in release by the 8.0.100-preview4 time frame. After that, we'll iterate on the logger to meet our goals for user experience and react to user feedback until we're satisfied with the performance and functionality. At that point, we'll enable the live logger by default in the .NET CLI and the feature will be officially released.

Items to tackle for final release

Before we can do that, the following items should be addressed:

• The outstanding PRs need to be merged. [FancyLogger] -> LiveLogger #8356, [FancyLogger] Show link to project outputs #8324, and [FancyLogger] Footer shows progress bar of completed projects #8314 all represent the latest work on the logger, and we need to get them integrated to serve as the foundation for further work.
• Live logger trims the message ID for SDK messages #8393
• An announcement blog for the preview2 timeframe needs to be drafted. I'd like to include @edvilme in the authoring of this post to talk about his time working on it.
• [LiveLogger] Tweak terminal UI to focus on in-progress work #8379 We need to iterate on the display of completed-but-irrelevant projects.
• Advertise LiveLogger during preview via logger output #8428 (Consider adding a message to the console logger output advertising LiveLogger during the preview timeframe)
• Make sure that the live logger is global ready #8391
• auto-scroll after scrolling after using live logger #8392
• LiveLogger should be a distributed logger #8384
• [LiveLogger] Logger responds to user themes #8429 (LiveLogger should respond to user themes)
• [LiveLogger] Adhere to coding & styling standards. #8430 (Perform code review of the code and cleanup coding/styling standards miss-steps)
• Test in multiple terminal emulators #8413
• [LiveLogger] Use correct opt-in state #8431 (Ensure LiveLogger has the right opt-in state to get the most modern logging including when combined with -bl)
• Enumerate live logger test matrix #8418
• [LiveLogger] Disambiguate restore operation from build, when run in -restore mode #8435
• Bug bash for preview 2
• [LiveLogger] logger should report build time. #8450
• [LiveLogger] Garbled output in cmd.exe #8455
• [LiveLogger] Don't render any yellow or red unless/until there is a warning/error #8456
• [LiveLogger] Many exceptions are thrown from the logger #8458
• [LiveLogger] Screen buffer has duplicated lines sometimes #8460
• [LiveLogger] Plug the logger into minimum message importance checks #8463
• [LiveLogger] Improve LiveLogger.Render performance #8464
• Colorize TF instead of enclosing it in brackets #8715
• [Feature Request]: Update VSCode Problem Matcher for MSBuild compilation errors to account for TerminalLogger formatting #8760
• TerminalLogger: VT-100 progress reporting codes #8878
• [Terminal Logger] Report final duration in hours/minutes/seconds when appropriate #8782
• [Bug]: Terminal logger formatting issue when displaying running targets #8781
• [LiveLogger] Use ProjectConfigurationDescription #8651

[edvilme]

Thank you for the shoutout and including me! 😀

[edvilme]

Regarding the second to last point... before I left I was considering sorting the projects such that the finished ones appear at the top, and that the buffer should scroll to the last added line. However I am unsure if this would hurt performance, and if it would mean a lot of jumping

[baronfel]

Sure thing @edvilme - I'm going to make separate issues for tracking the line items here, so we can go into details on those 👍

[edvilme]

Consider adding a message to the console logger output advertising LiveLogger during the preview timeframe

Does that mean showing something like "Using Console Logger. Try the new LiveLogger using the switch -livelogger"?

LiveLogger should respond to user themes

Does that mean like dark/light theme?

[Zastai]

Is there a link to documentation on corresponding features in MSBuild tasks, if there are any?

In particular, the "build complete, here is the resulting assembly" message is now retained with the assembly path turned into a hyperlink (or the publish directory for a publish).

Is there a way for build targets that generate other artifacts (in my case, a markdown file with the compiled assembly's public API) to have a similar result, including the hyperlink for the output file? Or is this currently the logger doing "hardcoded" detection of certain messages?

[rainersigwald]

Is there a way for build targets that generate other artifacts (in my case, a markdown file with the compiled assembly's public API) to have a similar result, including the hyperlink for the output file? Or is this currently the logger doing "hardcoded" detection of certain messages?

Currently it's hardcoded, yes. I have a design in my head to fix this, which I've been meaning to write down but hadn't got around to. Thanks for the reason to do so! #9608