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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021-2024 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/
#if canImport(NIOHTTP1)
import ArgumentParser
import Foundation
extension Docc {
/// Runs the ``Convert`` command and then sets up a web server that can be used to preview that documentation content.
public struct Preview: AsyncParsableCommand {
public init() {}
public static var configuration = CommandConfiguration(
abstract: "Convert documentation inputs and preview the documentation output.",
usage: """
docc preview [<catalog-path>] [--port <port-number>] [--additional-symbol-graph-dir <symbol-graph-dir>]
docc preview [<catalog-path>] [--port <port-number>] [--additional-symbol-graph-dir <symbol-graph-dir>] [--output-dir <output-dir>]
docc preview [<catalog-path>] [--port <port-number>] [--additional-symbol-graph-dir <symbol-graph-dir>] [--output-dir <output-dir>] [<availability-options>] [<diagnostic-options>] [<source-repository-options>] [<hosting-options>] [<info-plist-fallbacks>] [<feature-flags>] [<other-options>]
""",
discussion: """
The 'preview' command extends the 'convert' command by running a preview server and monitoring the documentation input for modifications to rebuild the documentation.
"""
)
/// The options used for configuring the preview server.
@OptionGroup(title: "Preview options")
public var previewOptions: PreviewOptions
public mutating func validate() throws {
// The default template wasn't validated by the Convert command.
// If a template was configured as an environmental variable, that would have already been validated in TemplateOption.
if previewOptions.convertCommand.templateOption.templateURL == nil {
throw TemplateOption.missingHTMLTemplateError(
path: previewOptions.convertCommand.templateOption.defaultTemplateURL.path
)
}
}
public func run() async throws {
var previewAction = try PreviewAction(fromPreviewOptions: previewOptions)
try await previewAction.performAndHandleResult()
}
}
}
#endif
|
