fix: apply SliceFlagSeparator to env var sources#2309
Open
lawrence3699 wants to merge 1 commit intourfave:mainfrom
Open
fix: apply SliceFlagSeparator to env var sources#2309lawrence3699 wants to merge 1 commit intourfave:mainfrom
lawrence3699 wants to merge 1 commit intourfave:mainfrom
Conversation
SliceFlagSeparator was ignored when a flag's value came from an environment variable. The separator config was only applied during CLI argument parsing (via cmd.set), but PostParse—which handles env var sources—never called setMultiValueParsingConfig. Fixes urfave#2262
There was a problem hiding this comment.
Pull request overview
Fixes a parsing bug where Command.SliceFlagSeparator was not honored when a slice flag’s value is sourced from environment variables (via PostParse), causing env-provided values to be split using the default separator instead of the configured one.
Changes:
- Apply multi-value parsing configuration (
SliceFlagSeparator,DisableSliceFlagSeparator,MapFlagKeyValueSeparator) before each flag’sPostParse()so env/file sources parse consistently with CLI parsing. - Add a regression test covering
SliceFlagSeparatorbehavior when aStringSliceFlagis set via an env var source.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
command_run.go |
Ensures multi-value parsing config is applied prior to PostParse(), fixing env var parsing for slice/map flags. |
command_test.go |
Adds a regression test validating that env-sourced StringSliceFlag respects SliceFlagSeparator. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
What type of PR is this?
What this PR does / why we need it:
SliceFlagSeparatoris ignored when a flag's value comes from an environment variable. The custom separator only works for CLI arguments.Root cause:
setMultiValueParsingConfigis called during CLI argument parsing (viacmd.set), butPostParse—which handles env var sources—never applies the separator config to the flag's underlyingSliceBase. The value is parsed with the default comma separator instead.Fix: Call
cmd.setMultiValueParsingConfig(flag)in thePostParseloop before env var values are read, soSliceBasehas the correct separator config.Before:
After:
Which issue(s) this PR fixes:
Fixes #2262
Validation:
TestCommandSliceFlagSeparatorFromEnvVar— fails before the fix, passes aftergo test ./...,go vet ./...)