feat: support env var as default flag value #75
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
github-actions
bot
added
core ⚙
mkubilayk
reviewed
Apr 9, 2025
| // 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.
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]>
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.
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.