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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 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
*/
import Foundation
import SwiftDocC
/// An action that emits documentation extension files that reflect the auto-generated curation.
struct EmitGeneratedCurationAction: AsyncAction {
let catalogURL: URL?
let additionalSymbolGraphDirectory: URL?
let outputURL: URL
let depthLimit: Int?
let startingPointSymbolLink: String?
let fileManager: FileManagerProtocol
init(
documentationCatalog: URL?,
additionalSymbolGraphDirectory: URL?,
outputURL: URL?,
depthLimit: Int?,
startingPointSymbolLink: String?,
fileManager: FileManagerProtocol = FileManager.default
) throws {
self.catalogURL = documentationCatalog
if let outputURL = outputURL ?? documentationCatalog {
self.outputURL = outputURL
} else {
self.outputURL = URL(fileURLWithPath: fileManager.currentDirectoryPath).appendingPathComponent("Generated.docc")
}
self.depthLimit = depthLimit
self.startingPointSymbolLink = startingPointSymbolLink
self.additionalSymbolGraphDirectory = additionalSymbolGraphDirectory
self.fileManager = fileManager
}
func perform(logHandle: inout LogHandle) async throws -> ActionResult {
let inputProvider = DocumentationContext.InputsProvider(fileManager: fileManager)
let (bundle, dataProvider) = try inputProvider.inputsAndDataProvider(
startingPoint: catalogURL,
options: BundleDiscoveryOptions(
infoPlistFallbacks: [:],
additionalSymbolGraphFiles: symbolGraphFiles(in: additionalSymbolGraphDirectory)
)
)
let context = try DocumentationContext(bundle: bundle, dataProvider: dataProvider)
let writer = GeneratedCurationWriter(context: context, catalogURL: catalogURL, outputURL: outputURL)
let curation = try writer.generateDefaultCurationContents(fromSymbol: startingPointSymbolLink, depthLimit: depthLimit)
for (url, updatedContent) in curation {
guard let data = updatedContent.data(using: .utf8) else { continue }
try fileManager.createDirectory(at: url.deletingLastPathComponent(), withIntermediateDirectories: true, attributes: nil)
try fileManager.createFile(at: url, contents: data, options: .atomic)
}
return ActionResult(didEncounterError: false, outputs: [outputURL])
}
}
private func symbolGraphFiles(in directory: URL?) -> [URL] {
guard let directory else { return [] }
let subpaths = FileManager.default.subpaths(atPath: directory.path) ?? []
return subpaths.map { directory.appendingPathComponent($0) }
.filter { DocumentationBundleFileTypes.isSymbolGraphFile($0) }
}
|
