DockerCLI/cli/command/stack
Sebastiaan van Stijn c60b360c33
cli: improve argument validation output
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>
2024-07-05 03:35:14 +02:00
..
formatter linting: fix incorrectly formatted errors (revive) 2022-03-28 10:37:25 +02:00
loader Update go:build comments to go1.21 2024-06-18 12:17:13 +02:00
options Add support for --detach/-d flag in stack rm 2024-03-04 09:56:53 +01:00
swarm linting: fmt.Sprintf can be replaced with string concatenation (perfsprint) 2024-06-10 21:19:32 +02:00
testdata remove obsolete mutli-orchestrator support 2022-02-22 15:28:12 +01:00
client_test.go vendor: github.com/docker/docker c6aaabc9fc82 (master / v27.0.0-dev) 2024-06-05 16:29:55 +02:00
cmd.go cli/command: use shallower interface for completions 2024-06-04 12:04:11 +02:00
common.go Drop support for (archived) Compose-on-Kubernetes 2022-02-22 13:47:34 +01:00
config.go golangci-lint: revive: enable import-shadowing 2023-11-20 19:52:41 +01:00
config_test.go test spring-cleaning 2024-07-04 01:35:12 +02:00
deploy.go Add support for --detach flag in stack deploy 2024-03-04 09:36:36 +01:00
deploy_test.go test spring-cleaning 2024-07-04 01:35:12 +02:00
list.go cli/command/stack: fix faulty sort for sorting stacks 2024-07-01 13:19:37 +02:00
list_test.go test spring-cleaning 2024-07-04 01:35:12 +02:00
ps.go Plumb contexts through commands 2023-12-12 22:30:16 +01:00
ps_test.go cli: improve argument validation output 2024-07-05 03:35:14 +02:00
remove.go Add support for --detach/-d flag in stack rm 2024-03-04 09:56:53 +01:00
remove_test.go test spring-cleaning 2024-07-04 01:35:12 +02:00
services.go Plumb contexts through commands 2023-12-12 22:30:16 +01:00
services_test.go test spring-cleaning 2024-07-04 01:35:12 +02:00