github.com/xeptore/docker-cli@v20.10.14+incompatible/cli/command/volume/list.go (about)

     1  package volume
     2  
     3  import (
     4  	"context"
     5  	"sort"
     6  
     7  	"github.com/docker/cli/cli"
     8  	"github.com/docker/cli/cli/command"
     9  	"github.com/docker/cli/cli/command/formatter"
    10  	"github.com/docker/cli/opts"
    11  	"github.com/fvbommel/sortorder"
    12  	"github.com/spf13/cobra"
    13  )
    14  
    15  type listOptions struct {
    16  	quiet  bool
    17  	format string
    18  	filter opts.FilterOpt
    19  }
    20  
    21  func newListCommand(dockerCli command.Cli) *cobra.Command {
    22  	options := listOptions{filter: opts.NewFilterOpt()}
    23  
    24  	cmd := &cobra.Command{
    25  		Use:     "ls [OPTIONS]",
    26  		Aliases: []string{"list"},
    27  		Short:   "List volumes",
    28  		Args:    cli.NoArgs,
    29  		RunE: func(cmd *cobra.Command, args []string) error {
    30  			return runList(dockerCli, options)
    31  		},
    32  	}
    33  
    34  	flags := cmd.Flags()
    35  	flags.BoolVarP(&options.quiet, "quiet", "q", false, "Only display volume names")
    36  	flags.StringVar(&options.format, "format", "", "Pretty-print volumes using a Go template")
    37  	flags.VarP(&options.filter, "filter", "f", "Provide filter values (e.g. 'dangling=true')")
    38  
    39  	return cmd
    40  }
    41  
    42  func runList(dockerCli command.Cli, options listOptions) error {
    43  	client := dockerCli.Client()
    44  	volumes, err := client.VolumeList(context.Background(), options.filter.Value())
    45  	if err != nil {
    46  		return err
    47  	}
    48  
    49  	format := options.format
    50  	if len(format) == 0 {
    51  		if len(dockerCli.ConfigFile().VolumesFormat) > 0 && !options.quiet {
    52  			format = dockerCli.ConfigFile().VolumesFormat
    53  		} else {
    54  			format = formatter.TableFormatKey
    55  		}
    56  	}
    57  
    58  	sort.Slice(volumes.Volumes, func(i, j int) bool {
    59  		return sortorder.NaturalLess(volumes.Volumes[i].Name, volumes.Volumes[j].Name)
    60  	})
    61  
    62  	volumeCtx := formatter.Context{
    63  		Output: dockerCli.Out(),
    64  		Format: formatter.NewVolumeFormat(format, options.quiet),
    65  	}
    66  	return formatter.VolumeWrite(volumeCtx, volumes.Volumes)
    67  }