Merge remote-tracking branch 'origin/v3-dev-main' into v3-porting

flag.go

@@ -83,6 +83,12 @@ func (f FlagsByName) Swap(i, j int) {
 	f[i], f[j] = f[j], f[i]
 }
 
+// ActionableFlag is an interface that wraps Flag interface and RunAction operation.
+type ActionableFlag interface {
+	Flag
+	RunAction(*Context) error
+}
+
 // Flag is a common interface related to parsing flags in cli.
 // For more advanced flag parsing techniques, it is recommended that
 // this interface be implemented.
@@ -97,33 +103,36 @@ type Flag interface {
 
 	// Whether the flag has been set or not
 	IsSet() bool
+}
+
+// RequiredFlag is an interface that allows us to mark flags as required
+// it allows flags required flags to be backwards compatible with the Flag interface
+type RequiredFlag interface {
+	Flag
 
 	// whether the flag is a required flag or not
 	IsRequired() bool
+}
 
-	// IsVisible returns true if the flag is not hidden, otherwise false
-	IsVisible() bool
-
-	// Returns the category of the flag
-	GetCategory() string
-
-	// GetUsage returns the usage string for the flag
-	GetUsage() string
-
-	// GetEnvVars returns the env vars for this flag
-	GetEnvVars() []string
+// DocGenerationFlag is an interface that allows documentation generation for the flag
+type DocGenerationFlag interface {
+	Flag
 
 	// TakesValue returns true if the flag takes a value, otherwise false
 	TakesValue() bool
 
-	// GetDefaultText returns the default text for this flag
-	GetDefaultText() string
+	// GetUsage returns the usage string for the flag
+	GetUsage() string
 
 	// GetValue returns the flags value as string representation and an empty
 	// string if the flag takes no value at all.
 	GetValue() string
 
-	RunAction(*Context) error
+	// GetDefaultText returns the default text for this flag
+	GetDefaultText() string
+
+	// GetEnvVars returns the env vars for this flag
+	GetEnvVars() []string
 }
 
 // DocGenerationFlag is an interface that allows documentation generation for the flag
@@ -155,6 +164,23 @@ type Countable interface {
 	Count() int
 }
 
+// VisibleFlag is an interface that allows to check if a flag is visible
+type VisibleFlag interface {
+	Flag
+
+	// IsVisible returns true if the flag is not hidden, otherwise false
+	IsVisible() bool
+}
+
+// CategorizableFlag is an interface that allows us to potentially
+// use a flag in a categorized representation.
+type CategorizableFlag interface {
+	VisibleFlag
+
+	// Returns the category of the flag
+	GetCategory() string
+}
+
 func flagSet(name string, flags []Flag) (*flag.FlagSet, error) {
 	set := flag.NewFlagSet(name, flag.ContinueOnError)
 
@@ -212,7 +238,7 @@ func normalizeFlags(flags []Flag, set *flag.FlagSet) error {
 func visibleFlags(fl []Flag) []Flag {
 	var visible []Flag
 	for _, f := range fl {
-		if f.IsVisible() {
+		if vf, ok := f.(VisibleFlag); ok && vf.IsVisible() {
 			visible = append(visible, f)
 		}
 	}