Create FancyLogger opt-in/out mechanism#8178
Merged
JaynieBai merged 42 commits intodotnet:mainfrom Dec 20, 2022
Merged
Conversation
edvilme
changed the title
Added FancyLogger (in development). Used with the /fancylogger commandline switch
edvilme
force-pushed
the
edvilme-fancy-logger
branch
from
e583016 to
fc46e3f
Compare
Renamed to a more descriptive name and replaced undisplayable characters with \|/-
Co-authored-by: Rainer Sigwald <[email protected]>
Default scrolling is disabled for the alternate buffer. Instead, it responds to up/down arrow keys for scrolling and rendering automatically
Targets are shown and marked as complete with checkmark and green color when finished
Calculated as completedTasks / existingTasks
Created class to encapsulate information and hierarchy of build events with their corresponding buffer line ids, and methods for expanding / collapsing (wip)
edvilme
changed the title
edvilme
force-pushed
the
edvilme-fancy-logger
branch
from
2280a64 to
62da1ea
Compare
rainersigwald
approved these changes
Dec 16, 2022
Member
rainersigwald
left a comment
rainersigwald
left a comment
There was a problem hiding this comment.
I really, really want the deferred messages for details on why the new logger is not used despite the opt-in but would be ok with a follow-up PR adding that.
…tly. Reviewed comments
Contributor
Author
It is added now :D |
Forgind
approved these changes
Dec 19, 2022
Contributor
Forgind
left a comment
Forgind
left a comment
There was a problem hiding this comment.
You should get rid of testing.txt, but this looks pretty good to me overall, minus stylistic nits 🙂
| @@ -0,0 +1,221 @@ | |||
| using System; | |||
| if (FancyLoggerBuffer.AutoScrollEnabled) break; | ||
| } | ||
| FancyLoggerBuffer.Terminate(); | ||
| Console.WriteLine("Build status, warnings and errors will be shown here after the build has ended and the interactive logger has closed"); |
Contributor
There was a problem hiding this comment.
This looks like it should be localized eventually ™️
| AutoScrollEnabled = true; | ||
| // Render contents | ||
| WriteTitleBar(); | ||
| WriteFooter("This is an empty footer haha"); |
Contributor
There was a problem hiding this comment.
Suggested change
| WriteFooter("This is an empty footer haha"); | |
| WriteFooter("This is an empty footer hoho"); |
Gotta get in the Christmas spirit!
| #region Writing | ||
| public static void WriteTitleBar() | ||
| { | ||
| Console.Write("" |
Contributor
There was a problem hiding this comment.
Why do you have to start there with "" + ? Could you just start with ANSIBuilder.Cursor.Home()?
| new ParameterlessSwitchInfo( new string[] { "filelogger8", "fl8" }, ParameterlessSwitch.FileLogger8, null), | ||
| new ParameterlessSwitchInfo( new string[] { "filelogger9", "fl9" }, ParameterlessSwitch.FileLogger9, null), | ||
| new ParameterlessSwitchInfo( new string[] { "distributedfilelogger", "dfl" }, ParameterlessSwitch.DistributedFileLogger, null), | ||
| new ParameterlessSwitchInfo( new string[] { "fancylogger", "flg" }, ParameterlessSwitch.FancyLogger, null), |
Contributor
There was a problem hiding this comment.
Do we want to make this a True/False thing so we can switch the default opt in/opt out behavior at some point?
edvilme
added
the
merge-when-branch-open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #
Context
For the average user, the current ConsoleLogger does not provide the required amount of information about the build, as it either shows too little information (with low verbosity levels) or too much information that it is very difficult to find (with high verbosity levels).
A better approach would be having the log update to show the necessary amount of information for the current performing action (be it a project, target or task) and hiding additional data for actions that completed successfully; thus reducing the amount of irrelevant info.
Likewise the addition of formatting (bold, italics, color) using ANSI escape codes provides the user with a much better experience.
A progress tracker for the build is also considered.
Changes Made
FancyLoggerclass.ANSIBuilderstatic class with helper methods for ANSI formatting and graphics/fancyloggerand/flgcommand line switches for enabling the FancyLogger$MSBUILDFANCYLOGGERenvironment variable for enabling the FancyLoggerTesting
Notes