mirror of
https://github.com/apple/swift-syntax.git
synced 2025-04-20 09:05:47 +08:00
3eedb6da12
In particular, not all members of syntax nodes have documentation and it is not realistic to add meaningful documentation to all of them in the near future.
91 lines
2.9 KiB
Swift
91 lines
2.9 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2023 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 the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
import ArgumentParser
|
|
import Foundation
|
|
import RegexBuilder
|
|
|
|
struct VerifyDocumentation: ParsableCommand {
|
|
static var configuration: CommandConfiguration {
|
|
CommandConfiguration(
|
|
abstract: "Verify that the docc documentation builds without warnings or errors."
|
|
)
|
|
}
|
|
|
|
@Flag(help: "Enable verbose logging.")
|
|
var verbose: Bool = false
|
|
|
|
func targetsInSwiftPackageIndexManifest() throws -> [String] {
|
|
let extractTargetRegex = Regex {
|
|
#/^ - /#
|
|
Capture(ZeroOrMore(.word))
|
|
#/$/#
|
|
}
|
|
let spiYmlFile = Paths.packageDir.appendingPathComponent(".spi.yml")
|
|
let spiYmlFileContents = try String(contentsOf: spiYmlFile)
|
|
return
|
|
spiYmlFileContents
|
|
.components(separatedBy: "\n")
|
|
.filter({ !$0.matches(of: extractTargetRegex).isEmpty })
|
|
.map { $0.replacing(extractTargetRegex) { $0.1 } }
|
|
.sorted()
|
|
}
|
|
|
|
func run() throws {
|
|
for target in try targetsInSwiftPackageIndexManifest() {
|
|
try buildDocumentation(product: target)
|
|
}
|
|
}
|
|
|
|
func xcodeVersion(xcodebuildExec: URL) throws -> (major: Int, minor: Int) {
|
|
let result = try ProcessRunner(
|
|
executableURL: xcodebuildExec,
|
|
arguments: ["-version"]
|
|
).run(captureStdout: true, captureStderr: false, verbose: false)
|
|
let xcodeVersionRegex = Regex {
|
|
"Xcode "
|
|
Capture(OneOrMore(.digit))
|
|
"."
|
|
Capture(OneOrMore(.digit))
|
|
}
|
|
guard let match = result.stdout.firstMatch(of: xcodeVersionRegex), let major = Int(match.1),
|
|
let minor = Int(match.2)
|
|
else {
|
|
throw ScriptExectutionError(message: "Failed to extract Xcode version to verify documentation")
|
|
}
|
|
return (major, minor)
|
|
}
|
|
|
|
func buildDocumentation(product: String) throws {
|
|
guard let xcodebuildExec = try? Paths.xcodebuildExec else {
|
|
return
|
|
}
|
|
logSection("Building documentation for \(product)")
|
|
var otherDoccFlags = ["--warnings-as-errors"]
|
|
if try xcodeVersion(xcodebuildExec: xcodebuildExec) >= (16, 0) {
|
|
otherDoccFlags.append("--disable-parameters-and-returns-validation")
|
|
}
|
|
try ProcessRunner(
|
|
executableURL: xcodebuildExec,
|
|
arguments: [
|
|
"docbuild",
|
|
"-workspace",
|
|
Paths.packageDir.path,
|
|
"-scheme",
|
|
product,
|
|
"-destination", "platform=macOS",
|
|
"OTHER_DOCC_FLAGS=\(otherDoccFlags.joined(separator: " "))",
|
|
]
|
|
).run(captureStdout: false, captureStderr: false, verbose: self.verbose)
|
|
}
|
|
}
|