mirror of
https://github.com/docker/compose.git
synced 2025-06-05 22:30:13 +02:00
9db79856be
This updates the format of various usage strings to be more consistent with other parts of the CLI. - Use `[OPTIONS]` to indicate where command-specific options should be added - Use `[SERVICE...]` to indicate zero-or-more services - Remove some usage strings for specific options (e.g. `-e NAME=VAL`), as that option is part of the already mentioned `[OPTIONS]` and we don't provide usage for each possible option that can be passed. - Remove `[--]`, which (I think) was needed for the Python implementation, but is a general feature to stop processing flag-options. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
70 lines
1.9 KiB
Go
70 lines
1.9 KiB
Go
/*
|
|
Copyright 2020 Docker Compose CLI authors
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package compose
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/docker/compose/v2/cmd/formatter"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/docker/compose/v2/internal"
|
|
)
|
|
|
|
type versionOptions struct {
|
|
format string
|
|
short bool
|
|
}
|
|
|
|
func versionCommand() *cobra.Command {
|
|
opts := versionOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: "version [OPTIONS]",
|
|
Short: "Show the Docker Compose version information",
|
|
Args: cobra.NoArgs,
|
|
RunE: func(cmd *cobra.Command, _ []string) error {
|
|
runVersion(opts)
|
|
return nil
|
|
},
|
|
PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
|
|
// overwrite parent PersistentPreRunE to avoid trying to load
|
|
// compose file on version command if COMPOSE_FILE is set
|
|
return nil
|
|
},
|
|
}
|
|
// define flags for backward compatibility with com.docker.cli
|
|
flags := cmd.Flags()
|
|
flags.StringVarP(&opts.format, "format", "f", "", "Format the output. Values: [pretty | json]. (Default: pretty)")
|
|
flags.BoolVar(&opts.short, "short", false, "Shows only Compose's version number.")
|
|
|
|
return cmd
|
|
}
|
|
|
|
func runVersion(opts versionOptions) {
|
|
if opts.short {
|
|
fmt.Println(strings.TrimPrefix(internal.Version, "v"))
|
|
return
|
|
}
|
|
if opts.format == formatter.JSON {
|
|
fmt.Printf("{\"version\":%q}\n", internal.Version)
|
|
return
|
|
}
|
|
fmt.Println("Docker Compose version", internal.Version)
|
|
}
|