Merge pull request #174 from rsteube/support-required

support required flags

command.go

@@ -88,6 +88,9 @@ func (c Command) addPersistentFlags(cmd *cobra.Command) error {
 			return err
 		}
 		flag.addTo(cmd.PersistentFlags())
+		if flag.required {
+			cmd.MarkFlagRequired(flag.longhand)
+		}
 	}
 	return nil
 }
@@ -99,6 +102,9 @@ func (c Command) addFlags(cmd *cobra.Command) error {
 			return err
 		}
 		flag.addTo(cmd.Flags())
+		if flag.required {
+			cmd.MarkFlagRequired(flag.longhand)
+		}
 	}
 	return nil
 }

docs/src/carapace-spec/command/flags.md

@@ -8,13 +8,16 @@ flags:
   -v=: shorthand with value
   --repeatable*: longhand repeatable
   -o, --optarg?: shorthand and longhand with optional argument
+  --hidden&: longhand hidden
+  --required!: longhand required
 ```
 
 ## Modifiers:
 - `=` flag takes an argument
 - `*` flag is repeatable
 - `?` flag takes an optional argument
-- `!` flag is hidden
+- `&` flag is hidden
+- `!` flag is required
 
 ## Non-posix
 

example/example.yaml

@@ -68,7 +68,8 @@ commands:
   description: hidden command
   hidden: true
   flags:
-    --hidden!=: hidden flag
+    --hidden&=: hidden flag
+    --required!: required flag
   completion:
     flag:
       hidden: ["first", "second", "third"]

flag.go

@@ -17,10 +17,11 @@ type flag struct {
 	value     bool
 	nonposix  bool
 	hidden    bool
+	required  bool
 }
 
 func parseFlag(s, usage string) (*flag, error) {
-	r := regexp.MustCompile(`^(?P<shorthand>-[^-][^ =*?!]*)?(, )?(?P<longhand>-[-]?[^ =*?!]*)?(?P<modifier>[=*?!]*)$`)
+	r := regexp.MustCompile(`^(?P<shorthand>-[^-][^ =*?&!]*)?(, )?(?P<longhand>-[-]?[^ =*?&!]*)?(?P<modifier>[=*?&!]*)$`)
 	if !r.MatchString(s) {
 		return nil, fmt.Errorf("flag syntax invalid: %v", s)
 	}
@@ -35,7 +36,8 @@ func parseFlag(s, usage string) (*flag, error) {
 	f.slice = strings.Contains(matches["modifier"], "*")
 	f.optarg = strings.Contains(matches["modifier"], "?")
 	f.value = f.optarg || strings.Contains(matches["modifier"], "=")
-	f.hidden = strings.Contains(matches["modifier"], "!")
+	f.hidden = strings.Contains(matches["modifier"], "&")
+	f.required = strings.Contains(matches["modifier"], "!")
 
 	if f.longhand == "" && f.shorthand == "" {
 		return nil, fmt.Errorf("malformed flag: '%v'", s)

scrape.go

@@ -130,6 +130,10 @@ func scrape(cmd *cobra.Command, tmpDir string) {
 		if f.Hidden {
 			fmt.Fprintf(out, `    %vCmd.Flag("%v").Hidden = true`+"\n", cmdVarName(cmd), f.Name)
 		}
+
+		if annotation := f.Annotations[cobra.BashCompOneRequiredFlag]; len(annotation) == 1 && annotation[0] == "true" {
+			fmt.Fprintf(out, `    %vCmd.MarkFlagRequired("%v")`+"\n", cmdVarName(cmd), f.Name)
+		}
 	})
 
 	if cmd.HasParent() {