Add SwiftCompile Support (#254)

Author: cpisciotta

Sources/XcbeautifyLib/CaptureGroups.swift

@@ -265,6 +265,36 @@ struct CompileCaptureGroup: CompileFileCaptureGroup {
     }
 }
 
+struct SwiftCompileCaptureGroup: CompileFileCaptureGroup {
+    static let outputType: OutputType = .task
+
+    /// Regular expression captured groups:
+    /// $1 = file path
+    /// $2 = filename (e.g. KWNull.m)
+    /// $3 = target
+    static let regex = Regex(pattern: #"^SwiftCompile \w+ \w+ ((?:\.|[^ ])+\/((?:\.|[^ ])+\.(?:m|mm|c|cc|cpp|cxx|swift))) \((in target '(.*)' from project '.*')\)$"#)
+
+    let filePath: String
+    let filename: String
+    let target: String
+
+    init?(groups: [String]) {
+        assert(groups.count >= 3)
+        guard let filePath = groups[safe: 0], let filename = groups[safe: 1], let target = groups.last else { return nil }
+        self.filePath = filePath
+        self.filename = filename
+        self.target = target
+    }
+}
+
+struct SwiftCompilingCaptureGroup: CaptureGroup {
+    static let outputType: OutputType = .task
+
+    static let regex = Regex(pattern: #"^SwiftCompile \w+ \w+ Compiling\\"#)
+
+    init?(groups: [String]) { }
+}
+
 struct CompileCommandCaptureGroup: CaptureGroup {
     static let outputType: OutputType = .task
 

Sources/XcbeautifyLib/Parser.swift

@@ -24,6 +24,8 @@ package class Parser {
         CodesignFrameworkCaptureGroup.self,
         CodesignCaptureGroup.self,
         CompileCaptureGroup.self,
+        SwiftCompileCaptureGroup.self,
+        SwiftCompilingCaptureGroup.self,
         CompileCommandCaptureGroup.self,
         CompileXibCaptureGroup.self,
         CompileStoryboardCaptureGroup.self,

Sources/XcbeautifyLib/Renderers/OutputRendering.swift

@@ -13,6 +13,7 @@ protocol OutputRendering {
     func formatCodeSign(group: CodesignCaptureGroup) -> String
     func formatCodeSignFramework(group: CodesignFrameworkCaptureGroup) -> String
     func formatCompile(group: CompileFileCaptureGroup) -> String
+    func formatSwiftCompiling(group: SwiftCompilingCaptureGroup) -> String?
     func formatCompileCommand(group: CompileCommandCaptureGroup) -> String?
     func formatCompileError(group: CompileErrorCaptureGroup, additionalLines: @escaping () -> (String?)) -> String
     func formatCompileWarning(group: CompileWarningCaptureGroup, additionalLines: @escaping () -> (String?)) -> String
@@ -114,6 +115,10 @@ extension OutputRendering {
             return formatCodeSignFramework(group: group)
         case let group as CompileCaptureGroup:
             return formatCompile(group: group)
+        case let group as SwiftCompileCaptureGroup:
+            return formatCompile(group: group)
+        case let group as SwiftCompilingCaptureGroup:
+            return formatSwiftCompiling(group: group)
         case let group as CompileCommandCaptureGroup:
             return formatCompileCommand(group: group)
         case let group as CompileErrorCaptureGroup:
@@ -302,6 +307,10 @@ extension OutputRendering {
         nil
     }
 
+    func formatSwiftCompiling(group: SwiftCompilingCaptureGroup) -> String? {
+        nil
+    }
+
     func formatCopy(group: CopyCaptureGroup) -> String {
         let filename = group.file
         let target = group.target

Sources/XcbeautifyLib/String+CapturedGroups.swift

@@ -13,6 +13,8 @@ extension String {
         CodesignCaptureGroup.self,
         CodesignFrameworkCaptureGroup.self,
         CompileCaptureGroup.self,
+        SwiftCompileCaptureGroup.self,
+        SwiftCompilingCaptureGroup.self,
         CompileCommandCaptureGroup.self,
         CompileXibCaptureGroup.self,
         CompileStoryboardCaptureGroup.self,

Tests/XcbeautifyLibTests/CaptureGroupTests.swift

@@ -0,0 +1,24 @@
+//
+//  CaptureGroupTests.swift
+//
+//
+//  Created by Charles Pisciotta on 2/25/24.
+//
+
+import XCTest
+@testable import XcbeautifyLib
+
+final class CaptureGroupTests: XCTestCase {
+    func testSwiftCompiling() {
+        let inputs = [
+            #"SwiftCompile normal x86_64 Compiling\ BackyardBirdsDataContainer.swift,\ ColorData.swift,\ DataGeneration.swift,\ DataGenerationOptions.swift /Backyard-Birds/BackyardBirdsData/General/BackyardBirdsDataContainer.swift /Backyard-Birds/BackyardBirdsData/General/ColorData.swift /Backyard-Birds/BackyardBirdsData/General/DataGeneration.swift /Backyard-Birds/BackyardBirdsData/General/DataGenerationOptions.swift (in target 'BackyardBirdsData' from project 'BackyardBirdsData')"#,
+            #"SwiftCompile normal x86_64 Compiling\ BackyardSnapshot.swift,\ BackyardSupplies.swift,\ BackyardTimeOfDay.swift,\ BackyardTimeOfDayColors.swift /Backyard-Birds/BackyardBirdsData/Backyards/BackyardSnapshot.swift /Backyard-Birds/BackyardBirdsData/Backyards/BackyardSupplies.swift /Backyard-Birds/BackyardBirdsData/Backyards/BackyardTimeOfDay.swift /Backyard-Birds/BackyardBirdsData/Backyards/BackyardTimeOfDayColors.swift (in target 'BackyardBirdsData' from project 'BackyardBirdsData')"#,
+            #"SwiftCompile normal arm64 Compiling\ PlantSpecies.swift,\ PlantSpeciesInfo.swift,\ PassIdentifiers.swift,\ GeneratedAssetSymbols.swift /Backyard-Birds/BackyardBirdsData/Plants/PlantSpecies.swift /Backyard-Birds/BackyardBirdsData/Plants/PlantSpeciesInfo.swift /Backyard-Birds/BackyardBirdsData/Store/PassIdentifiers.swift /Backyard-Birds/Build/Intermediates.noindex/BackyardBirdsData.build/Debug/BackyardBirdsData.build/DerivedSources/GeneratedAssetSymbols.swift (in target 'BackyardBirdsData' from project 'BackyardBirdsData')"#,
+            #"SwiftCompile normal arm64 Compiling\ resource_bundle_accessor.swift,\ Account+DataGeneration.swift,\ Account.swift,\ Backyard+DataGeneration.swift,\ Backyard.swift /Backyard-Birds/Build/Intermediates.noindex/BackyardBirdsData.build/Debug/BackyardBirdsData.build/DerivedSources/resource_bundle_accessor.swift /Backyard-Birds/BackyardBirdsData/Account/Account+DataGeneration.swift /Backyard-Birds/BackyardBirdsData/Account/Account.swift /Backyard-Birds/BackyardBirdsData/Backyards/Backyard+DataGeneration.swift /Backyard-Birds/BackyardBirdsData/Backyards/Backyard.swift (in target 'BackyardBirdsData' from project 'BackyardBirdsData')"#,
+        ]
+
+        for input in inputs {
+            XCTAssertTrue(SwiftCompilingCaptureGroup.regex.match(string: input))
+        }
+    }
+}

Tests/XcbeautifyLibTests/ParsingTests/ParsingTests.swift

@@ -36,7 +36,7 @@ final class ParsingTests: XCTestCase {
         // It uses `XCTAssertEqual` instead of `XCTAssertLessThanOrEqual` as a reminder.
         // Update this magic number whenever `uncapturedOutput` is less than the current magic number.
         // There's a regression whenever `uncapturedOutput` is greater than the current magic number.
-        XCTAssertEqual(uncapturedOutput, 2218)
+        XCTAssertEqual(uncapturedOutput, 2006)
     }
 
     func testLargeXcodebuildLog() throws {
@@ -73,6 +73,6 @@ final class ParsingTests: XCTestCase {
         // It uses `XCTAssertEqual` instead of `XCTAssertLessThanOrEqual` as a reminder.
         // Update this magic number whenever `uncapturedOutput` is less than the current magic number.
         // There's a regression whenever `uncapturedOutput` is greater than the current magic number.
-        XCTAssertEqual(uncapturedOutput, 77104)
+        XCTAssertEqual(uncapturedOutput, 69575)
     }
 }

Tests/XcbeautifyLibTests/RendererTests/GitHubActionsRendererTests.swift

@@ -110,6 +110,23 @@ final class GitHubActionsRendererTests: XCTestCase {
         #endif
     }
 
+    func testSwiftCompile_arm64() {
+        let input = "SwiftCompile normal arm64 /path/to/File.swift (in target 'Target' from project 'Project')"
+        let output = "[Target] Compiling File.swift"
+        XCTAssertEqual(logFormatted(input), output)
+    }
+
+    func testSwiftCompile_x86_64() {
+        let input = "SwiftCompile normal x86_64 /Backyard-Birds/Build/Intermediates.noindex/BackyardBirdsData.build/Debug/BackyardBirdsData.build/DerivedSources/resource_bundle_accessor.swift (in target 'BackyardBirdsData' from project 'BackyardBirdsData')"
+        let output = "[BackyardBirdsData] Compiling resource_bundle_accessor.swift"
+        XCTAssertEqual(logFormatted(input), output)
+    }
+
+    func testSwiftCompiling() {
+        let input = #"SwiftCompile normal x86_64 Compiling\ BackyardBirdsDataContainer.swift,\ ColorData.swift,\ DataGeneration.swift,\ DataGenerationOptions.swift /Backyard-Birds/BackyardBirdsData/General/BackyardBirdsDataContainer.swift /Backyard-Birds/BackyardBirdsData/General/ColorData.swift /Backyard-Birds/BackyardBirdsData/General/DataGeneration.swift /Backyard-Birds/BackyardBirdsData/General/DataGenerationOptions.swift (in target 'BackyardBirdsData' from project 'BackyardBirdsData')"#
+        XCTAssertNil(logFormatted(input))
+    }
+
     func testCompileStoryboard() {
         let formatted = logFormatted("CompileStoryboard /Users/admin/MyApp/MyApp/Main.storyboard (in target: MyApp)")
         XCTAssertEqual(formatted, "[MyApp] Compiling Main.storyboard")

Tests/XcbeautifyLibTests/RendererTests/TerminalRendererTests.swift

@@ -97,6 +97,23 @@ final class TerminalRendererTests: XCTestCase {
         #endif
     }
 
+    func testSwiftCompile_arm64() {
+        let input = "SwiftCompile normal arm64 /path/to/File.swift (in target 'Target' from project 'Project')"
+        let output = "[Target] Compiling File.swift"
+        XCTAssertEqual(noColoredFormatted(input), output)
+    }
+
+    func testSwiftCompile_x86_64() {
+        let input = "SwiftCompile normal x86_64 /Backyard-Birds/Build/Intermediates.noindex/BackyardBirdsData.build/Debug/BackyardBirdsData.build/DerivedSources/resource_bundle_accessor.swift (in target 'BackyardBirdsData' from project 'BackyardBirdsData')"
+        let output = "[BackyardBirdsData] Compiling resource_bundle_accessor.swift"
+        XCTAssertEqual(noColoredFormatted(input), output)
+    }
+
+    func testSwiftCompiling() {
+        let input = #"SwiftCompile normal x86_64 Compiling\ BackyardBirdsDataContainer.swift,\ ColorData.swift,\ DataGeneration.swift,\ DataGenerationOptions.swift /Backyard-Birds/BackyardBirdsData/General/BackyardBirdsDataContainer.swift /Backyard-Birds/BackyardBirdsData/General/ColorData.swift /Backyard-Birds/BackyardBirdsData/General/DataGeneration.swift /Backyard-Birds/BackyardBirdsData/General/DataGenerationOptions.swift (in target 'BackyardBirdsData' from project 'BackyardBirdsData')"#
+        XCTAssertNil(noColoredFormatted(input))
+    }
+
     func testCompileStoryboard() {
         let formatted = noColoredFormatted("CompileStoryboard /Users/admin/MyApp/MyApp/Main.storyboard (in target: MyApp)")
         XCTAssertEqual(formatted, "[MyApp] Compiling Main.storyboard")