123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990 |
- package cobra
-
- import (
- "fmt"
- )
-
- type PositionalArgs func(cmd *Command, args []string) error
-
- // Legacy arg validation has the following behaviour:
- // - root commands with no subcommands can take arbitrary arguments
- // - root commands with subcommands will do subcommand validity checking
- // - subcommands will always accept arbitrary arguments
- func legacyArgs(cmd *Command, args []string) error {
- // no subcommand, always take args
- if !cmd.HasSubCommands() {
- return nil
- }
-
- // root command with subcommands, do subcommand checking.
- if !cmd.HasParent() && len(args) > 0 {
- return fmt.Errorf("unknown command %q for %q%s", args[0], cmd.CommandPath(), cmd.findSuggestions(args[0]))
- }
- return nil
- }
-
- // NoArgs returns an error if any args are included.
- func NoArgs(cmd *Command, args []string) error {
- if len(args) > 0 {
- return fmt.Errorf("unknown command %q for %q", args[0], cmd.CommandPath())
- }
- return nil
- }
-
- // OnlyValidArgs returns an error if any args are not in the list of ValidArgs.
- func OnlyValidArgs(cmd *Command, args []string) error {
- if len(cmd.ValidArgs) > 0 {
- for _, v := range args {
- if !stringInSlice(v, cmd.ValidArgs) {
- return fmt.Errorf("invalid argument %q for %q%s", v, cmd.CommandPath(), cmd.findSuggestions(args[0]))
- }
- }
- }
- return nil
- }
-
- // ArbitraryArgs never returns an error.
- func ArbitraryArgs(cmd *Command, args []string) error {
- return nil
- }
-
- // MinimumNArgs returns an error if there is not at least N args.
- func MinimumNArgs(n int) PositionalArgs {
- return func(cmd *Command, args []string) error {
- if len(args) < n {
- return fmt.Errorf("requires at least %d arg(s), only received %d", n, len(args))
- }
- return nil
- }
- }
-
- // MaximumNArgs returns an error if there are more than N args.
- func MaximumNArgs(n int) PositionalArgs {
- return func(cmd *Command, args []string) error {
- if len(args) > n {
- return fmt.Errorf("accepts at most %d arg(s), received %d", n, len(args))
- }
- return nil
- }
- }
-
- // ExactArgs returns an error if there are not exactly n args.
- func ExactArgs(n int) PositionalArgs {
- return func(cmd *Command, args []string) error {
- if len(args) != n {
- return fmt.Errorf("accepts %d arg(s), received %d", n, len(args))
- }
- return nil
- }
- }
-
- // RangeArgs returns an error if the number of args is not within the expected range.
- func RangeArgs(min int, max int) PositionalArgs {
- return func(cmd *Command, args []string) error {
- if len(args) < min || len(args) > max {
- return fmt.Errorf("accepts between %d and %d arg(s), received %d", min, max, len(args))
- }
- return nil
- }
- }
|