1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2014-2022 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import ArgumentParser
import Basics
import CoreCommands
import Foundation
import PackageModel
import struct TSCBasic.StringError
extension SwiftPackageCommand {
struct Describe: AsyncSwiftCommand {
static let configuration = CommandConfiguration(
abstract: "Describe the current package")
@OptionGroup(visibility: .hidden)
var globalOptions: GlobalOptions
@Option(help: "json | text | mermaid")
var type: DescribeMode = .text
func run(_ swiftCommandState: SwiftCommandState) async throws {
let workspace = try swiftCommandState.getActiveWorkspace()
guard let packagePath = try swiftCommandState.getWorkspaceRoot().packages.first else {
throw StringError("unknown package")
}
let package = try await workspace.loadRootPackage(
at: packagePath,
observabilityScope: swiftCommandState.observabilityScope
)
try self.describe(package, in: type)
}
/// Emits a textual description of `package` to `stream`, in the format indicated by `mode`.
func describe(_ package: Package, in mode: DescribeMode) throws {
let desc = DescribedPackage(from: package)
let data: Data
switch mode {
case .json:
let encoder = JSONEncoder.makeWithDefaults()
encoder.keyEncodingStrategy = .convertToSnakeCase
data = try encoder.encode(desc)
case .text:
var encoder = PlainTextEncoder()
encoder.formattingOptions = [.prettyPrinted]
data = try encoder.encode(desc)
case .mermaid:
data = Data(MermaidPackageSerializer(package: package).renderedMarkdown.utf8)
}
print(String(decoding: data, as: UTF8.self))
}
enum DescribeMode: String, ExpressibleByArgument {
/// JSON format (guaranteed to be parsable and stable across time).
case json
/// Human readable format (not guaranteed to be parsable).
case text
/// Mermaid flow charts format
case mermaid
}
}
}
|
