add support for hidden flags

Author: codemodify

command-help-cmd.go

@@ -196,6 +196,10 @@ func (thisRef *Command) showUsage() {
 
 		globalFlagsStarted := false
 		for i, definedFlag := range flags {
+			if definedFlag.isHidden == "true" {
+				continue
+			}
+
 			definedFlag.name = fmt.Sprintf("%"+strconv.Itoa(-longestCommandOrFlagName)+"s", definedFlag.name)
 			definedFlag.name = " " + definedFlag.name
 
@@ -299,6 +303,7 @@ func paddedFlags(input []flag) []flag {
 			isRequired:   definedFlagPaddedIsRequired,
 			defaultValue: definedFlagPaddedDefaultValue,
 			description:  definedFlagPaddedDescription,
+			isHidden:     definedFlag.isHidden,
 		})
 	}
 

flag.go

@@ -15,6 +15,7 @@ const flagName = "flagName"               //
 const flagRequired = "flagRequired"       // required - needs inpuut from user
 const flagDefault = "flagDefault"         // default - would be the value if not set
 const flagDescription = "flagDescription" //
+const flagHidden = "flagHidden"           //
 
 type flag struct {
 	name                     string
@@ -23,6 +24,7 @@ type flag struct {
 	defaultValue             string
 	defaultValueWasRequested bool
 	description              string
+	isHidden                 string
 
 	wasSet bool
 }
@@ -52,6 +54,7 @@ func (thisRef *Command) getDefinedFlags() []flag {
 			isRequired:   runtimeStructRef.Type().Field(i).Tag.Get(flagRequired),
 			defaultValue: runtimeStructRef.Type().Field(i).Tag.Get(flagDefault),
 			description:  runtimeStructRef.Type().Field(i).Tag.Get(flagDescription),
+			isHidden:     runtimeStructRef.Type().Field(i).Tag.Get(flagHidden),
 		}
 
 		if _, tagFound := runtimeStructRef.Type().Field(i).Tag.Lookup(flagDefault); tagFound {

tests/11-command-with-hidden-flags_test.go

@@ -0,0 +1,20 @@
+package tests
+
+import (
+	"os"
+	"strings"
+	"testing"
+
+	clicmdflags "github.com/remoteit/systemkit-clicmdflags"
+)
+
+func Test11_CommandWithHiddenFlags_test(t *testing.T) {
+	args := "help"
+	os.Args = append(os.Args, strings.Split(args, " ")...)
+
+	if err := fiveCmd.Execute(); err != nil {
+		t.Fatal(err.Error())
+	}
+
+	clicmdflags.DEBUGDumpCommandFlags(fiveCmd)
+}

tests/helpers.go

@@ -102,3 +102,22 @@ var fourCmd = &clicmdflags.Command{
 		clicmdflags.DEBUGDumpCommandFlags(thisCmd)
 	},
 }
+
+// ~~~~ five ~~~~ ~~~~ ~~~~ ~~~~ ~~~~ ~~~~ ~~~~ ~~~~ ~~~~ ~~~~ ~~~~ ~~~~ ~~~~ ~~~~ ~~~~ ~~~~
+
+type fiveCmdFlags struct {
+	FiveCmdFlags1 bool `flagName:"fiveCmdFlags1" flagRequired:"true" flagHidden:"false" flagDescription:"fiveCmdFlags1 description"`
+	FiveCmdFlags2 bool `flagName:"fiveCmdFlags2" flagDefault:"false" flagHidden:"true"  flagDescription:"fiveCmdFlags2 description"`
+	FiveCmdFlags3 bool `flagName:"fiveCmdFlags3" flagRequired:"true" flagHidden:"false" flagDescription:"fiveCmdFlags3 description"`
+	FiveCmdFlags4 bool `flagName:"fiveCmdFlags4" flagDefault:"false" flagHidden:"true"  flagDescription:"fiveCmdFlags4 description"`
+}
+
+var fiveCmd = &clicmdflags.Command{
+	Name:        "fiveCmd",
+	Flags:       fiveCmdFlags{},
+	Description: "This is `fiveCmd` description",
+	Handler: func(thisCmd *clicmdflags.Command) {
+		fmt.Println("EXEC `fiveCmd`")
+		clicmdflags.DEBUGDumpCommandFlags(thisCmd)
+	},
+}