Merge pull request #802 from rsteube/spec-support-hidden

spec: support hidden
carapace-sh · Jul 10, 2023 · 5d11007 · 5d11007
2 parents 008b117 + 1dce090
commit 5d11007
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 8 deletions.
diff --git a/internal/pflagfork/flag.go b/internal/pflagfork/flag.go
@@ -6,6 +6,7 @@ import (
 	"strings"
 
 	"github.com/rsteube/carapace/pkg/style"
+	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 )
 
@@ -125,6 +126,13 @@ func (f Flag) Style() string {
 	}
 }
 
+func (f Flag) Required() bool {
+	if annotation := f.Annotations[cobra.BashCompOneRequiredFlag]; len(annotation) == 1 && annotation[0] == "true" {
+		return true
+	}
+	return false
+}
+
 func (f Flag) Definition() string {
 	var definition string
 	switch f.Mode() {
@@ -141,6 +149,14 @@ func (f Flag) Definition() string {
 		}
 	}
 
+	if f.Hidden {
+		definition += "&"
+	}
+
+	if f.Required() {
+		definition += "!"
+	}
+
 	if f.IsRepeatable() {
 		definition += "*"
 	}

diff --git a/internal/shell/spec/command.go b/internal/shell/spec/command.go
@@ -5,6 +5,8 @@ type Command struct {
 	Aliases         []string          `yaml:"aliases,omitempty"`
 	Description     string            `yaml:"description,omitempty"`
 	Group           string            `yaml:"group,omitempty"`
+	Hidden          bool              `yaml:"hidden,omitempty"`
+	ExclusiveFlags  [][]string        `yaml:"exclusiveflags,omitempty"`
 	Flags           map[string]string `yaml:"flags,omitempty"`
 	PersistentFlags map[string]string `yaml:"persistentflags,omitempty"`
 	Completion      struct {

diff --git a/internal/shell/spec/snippet.go b/internal/shell/spec/snippet.go
@@ -20,16 +20,15 @@ func command(cmd *cobra.Command) Command {
 		Description:     cmd.Short,
 		Aliases:         cmd.Aliases,
 		Group:           cmd.GroupID,
+		Hidden:          cmd.Hidden,
 		Flags:           make(map[string]string),
 		PersistentFlags: make(map[string]string),
 		Commands:        make([]Command, 0),
 	}
 
-	cmd.LocalFlags().VisitAll(func(flag *pflag.Flag) {
-		if flag.Hidden {
-			return
-		}
+	// TODO mutually exclusive flags
 
+	cmd.LocalFlags().VisitAll(func(flag *pflag.Flag) {
 		if cmd.PersistentFlags().Lookup(flag.Name) != nil {
 			return
 		}
@@ -40,16 +39,13 @@ func command(cmd *cobra.Command) Command {
 	})
 
 	cmd.PersistentFlags().VisitAll(func(flag *pflag.Flag) {
-		if flag.Hidden {
-			return
-		}
 		f := pflagfork.Flag{Flag: flag}
 		c.PersistentFlags[f.Definition()] = f.Usage
 
 	})
 
 	for _, subcmd := range cmd.Commands() {
-		if !subcmd.Hidden {
+		if subcmd.Name() != "_carapace" {
 			c.Commands = append(c.Commands, command(subcmd))
 		}
 	}