feat: support env var as default flag value #75
Conversation
github-actions
bot
added
core ⚙
| // THEN | ||
| compareToBaseline(this, StringArrayBaselineFormat, lines); | ||
| }); | ||
|
|
There was a problem hiding this comment.
Can we also add a redact: true test?
There was a problem hiding this comment.
Ah good catch, didn't have a case for redact in the formatting baselines.
There was a problem hiding this comment.
Oh at the moment there isn't any difference in the help text when redact: true is enabled. Should there be?
[--requiredBoolean/--noRequiredBoolean] required boolean flag [default = <from env REQUIRED_BOOLEAN>]
-h --help Print help information and exit
There was a problem hiding this comment.
At the moment the help text doesn't display the value of the environment variable, only the name. While I think it would be incredibly handy to print the value (or redacted value) we also still need to print the name and all of that takes up a lot of space. Not sure what the best display would be yet.
There was a problem hiding this comment.
Which of these options would be the best for displaying the default value? Right now we have the last one, which has the added benefit of not needing to read from the process to build the help text.
[--flag] some flag [default = ACTUAL_VALUE]
[--flag] some flag [default = ACTUAL_VALUE <from env REQUIRED_BOOLEAN>]
[--flag] some flag [default = <from env REQUIRED_BOOLEAN>]
With the following for redact: true
[--flag] some flag [default = ************]
[--flag] some flag [default = ************ <from env REQUIRED_BOOLEAN>]
[--flag] some flag [default = <from env REQUIRED_BOOLEAN>]
There was a problem hiding this comment.
My preference would be option (2) followed by (1) if length is a concern.
There was a problem hiding this comment.
Sounds good, we can do 2 and still have the backout to 3 if there is no value set.
molisani
force-pushed
the
feat/env-flag
branch
2 times, most recently
from
3d56824 to
9640f8b
Compare
Signed-off-by: Michael Molisani <[email protected]>
Signed-off-by: Michael Molisani <[email protected]>
Co-authored-by: Kubilay Kahveci <[email protected]> Signed-off-by: Michael Molisani <[email protected]>
Signed-off-by: mmolisani <[email protected]>
|
The output now looks like this depending on value/config:
I switched the redact character from * to █ so that it was even more obvious that the value is purposefully hidden. |
Resolves #62
Describe your changes
Expose functionality for application developers to pull the default value for a flag from an environment variable. This was already possible manually, but integrating it as a first-class feature allows for better formatting of error messages and the ability to "redact" the value in Stricli-generated output (for secrets).
Testing performed
Added several new test cases and updated the formatting baselines to achieve complete coverage.
Additional context
One side-effect is that
CommandContext["process"]is nowStricliProcessrather than justWritableStreamsto allowenvto be defined. The differences between the two types are just optional properties so there shouldn't be any issues.