print parameter value if and only if provided via CLI arg or config #464
Conversation
This file contains 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
cfbao
force-pushed
the
always-print-params
branch
2 times, most recently
from
69083a5 to
db130fc
Compare
This comment was marked as outdated.
This comment was marked as outdated.
cfbao
changed the title
cfbao
force-pushed
the
always-print-params
branch
from
5e00d24 to
3f1931c
Compare
cfbao
commented
Jul 22, 2024
| @@ -0,0 +1,14 @@ | |||
| namespace D2L.Bmx; | |||
|
|
|||
| internal record ParameterSource { | |||
There was a problem hiding this comment.
use a record type rather than an enum so it's:
- easy to customize
ToString() - easy to extend in the future to supply config file path
| @@ -0,0 +1,17 @@ | |||
| namespace D2L.Bmx; | |||
|
|
|||
| internal interface IConsoleWriter { | |||
There was a problem hiding this comment.
We're reasonably close to a point where some unit tests around our prompting and printing logic would be worthwhile.
I could really use a few when I was writing up #463
Interfaces are handy then.
Comment on lines
+39
to
+40
| if( !string.IsNullOrEmpty( account ) && !nonInteractive ) { | ||
| consoleWriter.WriteParameter( ParameterDescriptions.Account, account, accountSource ); |
There was a problem hiding this comment.
seems reasonable to not print these out when user has explicitly specified --non-interactive?
cfbao
commented
Jul 22, 2024
| Console.ForegroundColor = ConsoleColor.Cyan; | ||
| Console.Error.Write( value ); | ||
| Console.ForegroundColor = ConsoleColor.DarkGray; | ||
| Console.Error.WriteLine( $" (from {source})" ); |
There was a problem hiding this comment.
alternatively:
Suggested change
| Console.Error.WriteLine( $" (from {source})" ); | |
| Console.Error.WriteLine( $" (source: {source})" ); |
🤷
cfbao
commented
Jul 23, 2024
| @@ -21,24 +22,32 @@ BmxConfig config | |||
| bool nonInteractive, | |||
| bool ignoreCache | |||
| ) { | |||
| var orgSource = ParameterSource.CliArg; | |||
| if( string.IsNullOrEmpty( org ) && !string.IsNullOrEmpty( config.Org ) ) { | |||
There was a problem hiding this comment.
aside: writing all this overwrite/print/prompt logic really has a fizz buzz feel - it feels like you should be able to consolidate some actions and/or logical branches, but actually you can't...
cfbao
requested review from
boarnoah,
scowing,
jharoutuniand2l,
jkomonen and
gord5500
gord5500
approved these changes
Jul 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Why
Follow up to #463
As per Zoom discussion, BMX will always print parameter value & source if and only if it's provided via CLI args or config file.
I also made it colourful for legibility. The line seems too long and crowded without these colours.
The colours don't work if stdout is redirected, which is typical when using
bmx print. I know why this is happening. Will try to fix in a separate PR.Ticket
https://desire2learn.atlassian.net/browse/VUL-423