refactor(core): add a filter to get deprecated ArgSpec (#1446)

Author: jerome-quere

internal/core/arg_specs.go

@@ -24,6 +24,17 @@ func (s ArgSpecs) GetPositionalArg() *ArgSpec {
 	return positionalArg
 }
 
+// GetDeprecated gets all fields filtered by the deprecation state.
+func (s ArgSpecs) GetDeprecated(deprecated bool) ArgSpecs {
+	result := ArgSpecs{}
+	for _, argSpec := range s {
+		if argSpec.Deprecated == deprecated {
+			result = append(result, argSpec)
+		}
+	}
+	return result
+}
+
 func (s ArgSpecs) GetByName(name string) *ArgSpec {
 	for _, spec := range s {
 		if spec.Name == name {

internal/core/autocomplete.go

@@ -216,12 +216,8 @@ func BuildAutoCompleteTree(commands *Commands) *AutoCompleteNode {
 		node.Command = cmd
 
 		// We consider ArgSpecs as leaf in the autocomplete tree.
-		for _, argSpec := range cmd.ArgSpecs {
-			if argSpec.Deprecated {
-				// Do not autocomplete deprecated arguments.
-				continue
-			}
-
+		nonDeprecatedArgs := cmd.ArgSpecs.GetDeprecated(false)
+		for _, argSpec := range nonDeprecatedArgs {
 			if argSpec.Positional {
 				node.Children[positionalValueNodeID] = NewAutoCompleteArgNode(cmd, argSpec)
 				continue

internal/core/cobra_usage_builder.go

@@ -25,12 +25,7 @@ func buildUsageArgs(ctx context.Context, cmd *Command, deprecated bool) string {
 	tw := tabwriter.NewWriter(&argsBuffer, 0, 0, 3, ' ', 0)
 
 	// Filter deprecated argSpecs.
-	argSpecs := ArgSpecs(nil)
-	for _, argSpec := range cmd.ArgSpecs {
-		if argSpec.Deprecated == deprecated {
-			argSpecs = append(argSpecs, argSpec)
-		}
-	}
+	argSpecs := cmd.ArgSpecs.GetDeprecated(deprecated)
 
 	err := _buildUsageArgs(ctx, tw, argSpecs)
 	if err != nil {

internal/core/cobra_utils.go

@@ -202,10 +202,9 @@ Relative time error: %s
 
 	case *args.UnknownArgError, *args.InvalidArgNameError:
 		argNames := []string(nil)
-		for _, argSpec := range cmd.ArgSpecs {
-			if !argSpec.Deprecated {
-				argNames = append(argNames, argSpec.Name)
-			}
+		nonDeprecatedArgs := cmd.ArgSpecs.GetDeprecated(false)
+		for _, argSpec := range nonDeprecatedArgs {
+			argNames = append(argNames, argSpec.Name)
 		}
 
 		return &CliError{

internal/core/validate.go

@@ -114,11 +114,10 @@ func validateNoConflict(cmd *Command, rawArgs args.RawArgs) error {
 
 // validateDeprecated print a warning message if a deprecated argument is used
 func validateDeprecated(ctx context.Context, cmd *Command) {
-	for _, argSpec := range cmd.ArgSpecs {
-		if argSpec.Deprecated {
-			helpCmd := cmd.GetCommandLine(extractMeta(ctx).BinaryName) + " --help"
-			ExtractLogger(ctx).Warningf("The argument '%s' is deprecated, more info with: %s\n", argSpec.Name, helpCmd)
-		}
+	deprecatedArgs := cmd.ArgSpecs.GetDeprecated(true)
+	for _, argSpec := range deprecatedArgs {
+		helpCmd := cmd.GetCommandLine(extractMeta(ctx).BinaryName) + " --help"
+		ExtractLogger(ctx).Warningf("The argument '%s' is deprecated, more info with: %s\n", argSpec.Name, helpCmd)
 	}
 }