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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
/*
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
*/
import Foundation
import SwiftDocC
/// An action that emits a static hostable website from a DocC Archive.
struct TransformForStaticHostingAction: Action {
let rootURL: URL
let outputURL: URL
let hostingBasePath: String?
let outputIsExternal: Bool
let htmlTemplateDirectory: URL
let fileManager: FileManagerProtocol
var diagnosticEngine: DiagnosticEngine
/// Initializes the action with the given validated options, creates or uses the given action workspace & context.
init(documentationBundleURL: URL,
outputURL:URL?,
hostingBasePath: String?,
htmlTemplateDirectory: URL,
fileManager: FileManagerProtocol = FileManager.default,
diagnosticEngine: DiagnosticEngine = .init()) throws
{
// Initialize the action context.
self.rootURL = documentationBundleURL
self.outputURL = outputURL ?? documentationBundleURL
self.outputIsExternal = outputURL != nil
self.hostingBasePath = hostingBasePath
self.htmlTemplateDirectory = htmlTemplateDirectory
self.fileManager = fileManager
self.diagnosticEngine = diagnosticEngine
self.diagnosticEngine.add(DiagnosticConsoleWriter(formattingOptions: [], baseURL: documentationBundleURL))
}
/// Converts each eligible file from the source archive and
/// saves the results in the given output folder.
mutating func perform(logHandle: LogHandle) throws -> ActionResult {
try emit()
return ActionResult(didEncounterError: false, outputs: [outputURL])
}
mutating private func emit() throws {
// If the emit is to create the static hostable content outside of the source archive
// then the output folder needs to be set up and the archive data copied
// to the new folder.
if outputIsExternal {
try setupOutputDirectory(outputURL: outputURL)
// Copy the appropriate folders from the archive.
// We will copy individual items from the folder rather then just copy the folder
// as we want to preserve anything intentionally left in the output URL by `setupOutputDirectory`
for sourceItem in try fileManager.contentsOfDirectory(at: rootURL, includingPropertiesForKeys: [], options:[.skipsHiddenFiles]) {
let targetItem = outputURL.appendingPathComponent(sourceItem.lastPathComponent)
try fileManager.copyItem(at: sourceItem, to: targetItem)
}
}
// Copy the HTML template to the output folder.
var excludedFiles = [HTMLTemplate.templateFileName.rawValue]
if outputIsExternal {
excludedFiles.append(HTMLTemplate.indexFileName.rawValue)
}
for content in try fileManager.contentsOfDirectory(atPath: htmlTemplateDirectory.path) {
guard !excludedFiles.contains(content) else { continue }
let source = htmlTemplateDirectory.appendingPathComponent(content)
let target = outputURL.appendingPathComponent(content)
if fileManager.fileExists(atPath: target.path){
try fileManager.removeItem(at: target)
}
try fileManager.copyItem(at: source, to: target)
}
// Transform the indexHTML if needed.
let indexHTMLData = try StaticHostableTransformer.indexHTMLData(
in: htmlTemplateDirectory,
with: hostingBasePath,
fileManager: FileManager.default
)
// Create a StaticHostableTransformer targeted at the archive data folder
let dataProvider = try LocalFileSystemDataProvider(rootURL: rootURL.appendingPathComponent(NodeURLGenerator.Path.dataFolderName))
let transformer = StaticHostableTransformer(dataProvider: dataProvider, fileManager: fileManager, outputURL: outputURL, indexHTMLData: indexHTMLData)
try transformer.transform()
}
/// Create output directory or empty its contents if it already exists.
private func setupOutputDirectory(outputURL: URL) throws {
var isDirectory: ObjCBool = false
if fileManager.fileExists(atPath: outputURL.path, isDirectory: &isDirectory), isDirectory.boolValue {
let contents = try fileManager.contentsOfDirectory(at: outputURL, includingPropertiesForKeys: [], options: [.skipsHiddenFiles])
for content in contents {
try fileManager.removeItem(at: content)
}
} else {
try fileManager.createDirectory(at: outputURL, withIntermediateDirectories: false, attributes: [:])
}
}
}
|
