c60b360c33
Improve the output for these validation errors:
- Removes the short command description from the output. This information
does not provide much useful help, and distracts from the error message.
- Reduces punctuation, and
- Prefixes the error message with the binary / root-command name
(usually `docker:`) to be consistent with other similar errors.
- Adds an empty line between the error-message and the "call to action"
(`Run 'docker volume --help'...` in the example below). This helps
separating the error message and "usage" from the call-to-action.
Before this patch:
$ docker volume ls one two three
"docker volume ls" accepts no arguments.
See 'docker volume ls --help'.
Usage: docker volume ls [OPTIONS]
List volumes
$ docker volume create one two three
"docker volume create" requires at most 1 argument.
See 'docker volume create --help'.
Usage: docker volume create [OPTIONS] [VOLUME]
Create a volume
With this patch:
$ docker volume ls one two three
docker: 'docker volume ls' accepts no arguments
Usage: docker volume ls [OPTIONS]
Run 'docker volume ls --help' for more information
$ docker voludocker volume create one two three
docker: 'docker volume create' requires at most 1 argument
Usage: docker volume create [OPTIONS] [VOLUME]
SRun 'docker volume create --help' for more information
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
113 lines
2.8 KiB
Go
113 lines
2.8 KiB
Go
package cli
|
|
|
|
import (
|
|
"github.com/pkg/errors"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
// NoArgs validates args and returns an error if there are any args
|
|
func NoArgs(cmd *cobra.Command, args []string) error {
|
|
if len(args) == 0 {
|
|
return nil
|
|
}
|
|
|
|
if cmd.HasSubCommands() {
|
|
return errors.Errorf(
|
|
"%[1]s: unknown command: %[2]s %[3]s\n\nUsage: %[4]s\n\nRun '%[2]s --help' for more information",
|
|
binName(cmd),
|
|
cmd.CommandPath(),
|
|
args[0],
|
|
cmd.UseLine(),
|
|
)
|
|
}
|
|
|
|
return errors.Errorf(
|
|
"%[1]s: '%[2]s' accepts no arguments\n\nUsage: %[3]s\n\nRun '%[2]s --help' for more information",
|
|
binName(cmd),
|
|
cmd.CommandPath(),
|
|
cmd.UseLine(),
|
|
)
|
|
}
|
|
|
|
// RequiresMinArgs returns an error if there is not at least min args
|
|
func RequiresMinArgs(min int) cobra.PositionalArgs {
|
|
return func(cmd *cobra.Command, args []string) error {
|
|
if len(args) >= min {
|
|
return nil
|
|
}
|
|
return errors.Errorf(
|
|
"%[1]s: '%[2]s' requires at least %[3]d %[4]s\n\nUsage: %[5]s\n\nSee '%[2]s --help' for more information",
|
|
binName(cmd),
|
|
cmd.CommandPath(),
|
|
min,
|
|
pluralize("argument", min),
|
|
cmd.UseLine(),
|
|
)
|
|
}
|
|
}
|
|
|
|
// RequiresMaxArgs returns an error if there is not at most max args
|
|
func RequiresMaxArgs(max int) cobra.PositionalArgs {
|
|
return func(cmd *cobra.Command, args []string) error {
|
|
if len(args) <= max {
|
|
return nil
|
|
}
|
|
return errors.Errorf(
|
|
"%[1]s: '%[2]s' requires at most %[3]d %[4]s\n\nUsage: %[5]s\n\nSRun '%[2]s --help' for more information",
|
|
binName(cmd),
|
|
cmd.CommandPath(),
|
|
max,
|
|
pluralize("argument", max),
|
|
cmd.UseLine(),
|
|
)
|
|
}
|
|
}
|
|
|
|
// RequiresRangeArgs returns an error if there is not at least min args and at most max args
|
|
func RequiresRangeArgs(min int, max int) cobra.PositionalArgs {
|
|
return func(cmd *cobra.Command, args []string) error {
|
|
if len(args) >= min && len(args) <= max {
|
|
return nil
|
|
}
|
|
return errors.Errorf(
|
|
"%[1]s: '%[2]s' requires at least %[3]d and at most %[4]d %[5]s\n\nUsage: %[6]s\n\nRun '%[2]s --help' for more information",
|
|
binName(cmd),
|
|
cmd.CommandPath(),
|
|
min,
|
|
max,
|
|
pluralize("argument", max),
|
|
cmd.UseLine(),
|
|
)
|
|
}
|
|
}
|
|
|
|
// ExactArgs returns an error if there is not the exact number of args
|
|
func ExactArgs(number int) cobra.PositionalArgs {
|
|
return func(cmd *cobra.Command, args []string) error {
|
|
if len(args) == number {
|
|
return nil
|
|
}
|
|
return errors.Errorf(
|
|
"%[1]s: '%[2]s' requires %[3]d %[4]s\n\nUsage: %[5]s\n\nRun '%[2]s --help' for more information",
|
|
binName(cmd),
|
|
cmd.CommandPath(),
|
|
number,
|
|
pluralize("argument", number),
|
|
cmd.UseLine(),
|
|
)
|
|
}
|
|
}
|
|
|
|
// binName returns the name of the binary / root command (usually 'docker').
|
|
func binName(cmd *cobra.Command) string {
|
|
return cmd.Root().Name()
|
|
}
|
|
|
|
//nolint:unparam
|
|
func pluralize(word string, number int) string {
|
|
if number == 1 {
|
|
return word
|
|
}
|
|
return word + "s"
|
|
}
|