Files
container/Sources/CLI/Volume/VolumeList.swift
Morris Richman dd6bdc20cf Expose Command Structs for Plugins (#603)
## Type of Change
- [ ] Bug fix
- [x] New feature  
- [ ] Breaking change
- [ ] Documentation update

## Motivation and Context
Plugins technically exist, but to add shortcuts or to do existing things
with functions in `container` requires calling a compiled binary. This
pull request aims to remove that hurdle and instability by exposing
commands as a new `ContainerCommands ` target.

Simply import `ContainerCommands` and you can access almost
any command as if it were a native part of the binary. This makes
plugin development significantly easier.

Closes #609.
2025-09-17 15:24:26 -07:00

81 lines
2.6 KiB
Swift

//===----------------------------------------------------------------------===//
// Copyright © 2025 Apple Inc. and the container project authors. All rights reserved.
//
// 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
//
// https://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.
//===----------------------------------------------------------------------===//
import ArgumentParser
import ContainerClient
import ContainerizationExtras
import Foundation
extension Application.VolumeCommand {
public struct VolumeList: AsyncParsableCommand {
public init() {}
public static let configuration = CommandConfiguration(
commandName: "list",
abstract: "List volumes",
aliases: ["ls"]
)
@Flag(name: .shortAndLong, help: "Only display volume names")
var quiet: Bool = false
@Option(name: .long, help: "Format of the output")
var format: Application.ListFormat = .table
public func run() async throws {
let volumes = try await ClientVolume.list()
try printVolumes(volumes: volumes, format: format)
}
private func createHeader() -> [[String]] {
[["NAME", "DRIVER", "OPTIONS"]]
}
func printVolumes(volumes: [Volume], format: Application.ListFormat) throws {
if format == .json {
let data = try JSONEncoder().encode(volumes)
print(String(data: data, encoding: .utf8)!)
return
}
if quiet {
volumes.forEach {
print($0.name)
}
return
}
var rows = createHeader()
for volume in volumes {
rows.append(volume.asRow)
}
let formatter = TableOutput(rows: rows)
print(formatter.format())
}
}
}
extension Volume {
var asRow: [String] {
let optionsString = options.isEmpty ? "" : options.map { "\($0.key)=\($0.value)" }.joined(separator: ",")
return [
self.name,
self.driver,
optionsString,
]
}
}