Add support for setting a global env var prefix #258
Merged
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.
This PR implements support for setting a global env var prefix (see linked issue).
While writing common reusable args structs for our Go programs today, I realized on the value and usefulness of this feature in real-world applications and decided to implement it for
go-arg
.The implementation adds a new
EnvPrefix
field inConfig
and therefore is only accessible when usingNewParser()
.Because the implementation adds the prefix to
spec.env
, the prefix is reflected everywhere, including usage help text.To write the unit test, I had to extend
parseWithEnv
so aConfig
can be passed instead of hard-codingConfig{}
.And last but not least, an example in the README was using
os.Args
instead ofos.Args[1:]
inp.Parse()
. This probably came from a very outdated version, but I fixed it as well now.Resolves #204