Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add MarkIfFlagPresentThenOthersRequired #2200

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

faizan-siddiqui
Copy link

This PR introduces a new flag group function, MarkIfFlagPresentThenOthersRequired, which enforces a "one-way required together" relationship among flags. This means that if a primary flag is set, then other dependent flags must also be set. This allows users to make certain flags conditionally required based on the presence of another flag, while maintaining flexibility when the primary flag is not provided.

Example

Consider a command called get-range that uses the flags --start and --end to specify a date range. By default, the command can run without either flag, using default start and end values (e.g., start=someDefaultStart and end=Now). However, you may want to enforce that if the user specifies an --end, they must also specify a --start.

cmd := &cobra.Command{
    Use: "get-range",
}

cmd.Flags().String("start", "", "Start date")
cmd.Flags().String("end", "", "End date")

// If --end is set, --start is required
cmd.MarkIfFlagPresentThenRequired("end", "start")
  • If the command is called with only --end=value, it will trigger an error because --start is missing.
  • If called without any flags or only with --start, it will run using the default values or the provided start date.

This change makes it easier to enforce dependencies between flags while allowing flexible defaults when the primary flag is not specified.

@CLAassistant
Copy link

CLAassistant commented Oct 23, 2024

CLA assistant check
All committers have signed the CLA.

@faizan-siddiqui
Copy link
Author

@marckhouzam Would love to get this in thanks! Let me know if you have any questions :)

@faizan-siddiqui
Copy link
Author

@dpetersen @markbates @EdwardBetts Would love to get this in thanks! Let me know if you have any questions :)

@danpalmer
Copy link

@marckhouzam is there anything we can do to get this moving? Alternatively we're happy to have discussions about it being out of scope, it just felt fairly obviously useful to us.

@marckhouzam
Copy link
Collaborator

I like the idea. I’ll put it on my queue to review. Thank you.

flag_groups.go Outdated Show resolved Hide resolved
flag_groups_test.go Outdated Show resolved Hide resolved
flag_groups.go Outdated Show resolved Hide resolved
@faizan-siddiqui
Copy link
Author

Hi @ccoVeille thank you for the review, I have committed your suggested changes

if f == nil {
panic(fmt.Sprintf("Failed to find flag %q and mark it as being in an if present then others required flag group", v))
}
// Each time this is called is a single new entry; this allows it to be a member of multiple groups if needed.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this tested? I mean covered by a test that will ensure it will stay like this if there is a future refactoring

Comment on lines +26 to +29
requiredAsGroupAnnotation = "cobra_annotation_required_if_others_set"
oneRequiredAnnotation = "cobra_annotation_one_required"
mutuallyExclusiveAnnotation = "cobra_annotation_mutually_exclusive"
ifPresentThenOthersRequiredAnnotation = "cobra_annotation_if_present_then_others_required"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you rename them in a way they share a common prefix, not suffix

These constants are defined at the package level, so IDE will suggest them in any method when coding in that package

I would like to see something like this

Suggested change
requiredAsGroupAnnotation = "cobra_annotation_required_if_others_set"
oneRequiredAnnotation = "cobra_annotation_one_required"
mutuallyExclusiveAnnotation = "cobra_annotation_mutually_exclusive"
ifPresentThenOthersRequiredAnnotation = "cobra_annotation_if_present_then_others_required"
annotationGroupRequired = "cobra_annotation_required_if_others_set"
annotationRequiredOne = "cobra_annotation_one_required"
annotationMutuallyExclusive = "cobra_annotation_mutually_exclusive"
annotationGroupDependent = "cobra_annotation_if_present_then_others_required"

The names of the constants are just suggestions to give you an idea

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants