Merge pull request #7 from Wei18/feat/scipio

Feat: Use scipio for generating static frameworks to optimize compilation time.

Author: wei18

Makefile

@@ -55,22 +55,31 @@ endif
 install: check-submodule $(SWIFT_FILES)
 	@echo "::notice:: make $@"
 
-#XCFrameworks:
-#	mint run giginet/Scipio create . \
-#		--embed-debug-symbols \
-#		--support-simulators
-#	echo "::notice:: make $@"
+XCFrameworks:
+	mint run giginet/Scipio create . \
+		--static \
+		--embed-debug-symbols \
+		--support-simulators
+	@touch $@
+	@echo "::notice:: make $@"
+
+%.zip: %.xcframework
+	@zip -qr "$@" "$<"
+	@rm -rf "$<"
+	@git add "$@"
+	@echo "::debug:: make $@"
+
+install-zips: XCFrameworks
+	@$(MAKE) $(shell echo XCFrameworks/*.xcframework | sed 's/\.xcframework/\.zip/g');
+# 	@git commit -m "[Make] Modify xcframework zips" || true
+# 	@echo "::notice:: make $@"
 
-#XCFRAMEWORKS := $(wildcard XCFrameworks/*.xcframework)
-#ZIP_FILES := $(XCFRAMEWORKS:%.xcframework=%.zip)
-#%.zip: %.xcframework
-#	zip -r "$@" "$^"
-#	rm -rf "$^"
-#	git add "$@"
-#
-#install-zips: XCFrameworks $(ZIP_FILES)
-#	git commit -m "[Make] Re-gen framework zips" || true
-#	echo "::notice:: make $@"
+.PHONY: update-to-date
+update-to-date:
+	touch Submodule
+	touch Sources/**/openapi-generator-config.yml
+	touch Sources/**/openapi.yml
+	touch Sources/**/Client.swift
 
 #.build/docs: ## Need env GITHUB_PAGES is created as 'true'
 #	swift package --allow-writing-to-directory $@ generate-documentation \

Mintfile

@@ -1 +1,2 @@
-apple/swift-openapi-generator@1.1.0
+apple/swift-openapi-generator@1.1.0
+giginet/Scipio@0.17.2

Package.swift

@@ -4,7 +4,36 @@
 import PackageDescription
 import Foundation
 
-/// The generator supports filtering the OpenAPI document prior to generation, 
+let isBuildingCode = ProcessInfo.processInfo.environment["BUILD_CODE"] == "true"
+let isBuildingDocC = ProcessInfo.processInfo.environment["GITHUB_PAGES"] == "true"
+
+let package = Package(
+    name: "GitHubRestAPISwiftOpenAPI",
+    platforms: [.macOS(.v10_15)],
+    products: GitHubRestAPIOpenAPITag.allCases.map(\.library),
+    dependencies: [
+        .package(url: "https://github.com/apple/swift-openapi-runtime", from: "1.0.0"),
+        .package(url: "https://github.com/apple/swift-openapi-urlsession", from: "1.0.0"),
+    ],
+    targets: GitHubRestAPIOpenAPITag.allCases.map(\.target)
+    + GitHubRestAPIOpenAPITag.allCases.compactMap(\.testTarget)
+)
+
+// dependencies is needed for package users
+if !isBuildingCode {
+    package.targets += [
+        GitHubRestAPIOpenAPITag.dependenciesTarget
+    ]
+}
+
+// swift-docs is not needed for package users
+if isBuildingDocC {
+    package.dependencies += [
+        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.3.0"),
+    ]
+}
+
+/// The generator supports filtering the OpenAPI document prior to generation,
 /// which can be useful when generating client code for a subset of a large API, 
 /// or splitting an implementation of a server across multiple modules.
 enum GitHubRestAPIOpenAPITag: String, CaseIterable {
@@ -46,62 +75,70 @@ enum GitHubRestAPIOpenAPITag: String, CaseIterable {
     case classroom
     case desktop
 
-    var targetName: String {
+    var library: PackageDescription.Product {
+        let targetName = targetName
+        if isBuildingCode {
+            return .library(
+                name: targetName,
+                targets: [targetName]
+            )
+        } else {
+            return .library(
+                name: targetName,
+                targets: [targetName, Self.dependenciesTarget.name]
+            )
+        }
+    }
+
+    private var targetName: String {
         let name = rawValue.replacingOccurrences(of: "-", with: "_").capitalized
         return "GitHubRestAPI\(name)"
     }
 
     var target: PackageDescription.Target {
         let targetName = targetName
-        return .target(
-            name: targetName,
-            dependencies: [
-                .product(name: "OpenAPIRuntime", package: "swift-openapi-runtime"),
-                .product(name: "OpenAPIURLSession", package: "swift-openapi-urlsession"),
-            ],
-            path: "Sources/\(rawValue)",
-            exclude: [
-                "openapi-generator-config.yml",
-                "openapi.yml",
-            ]
-        )
-    }
-
-    var library: PackageDescription.Product {
-        let targetName = targetName
-        return .library(
-            name: targetName,
-            targets: [targetName]
-        )
+        if isBuildingCode {
+            return .target(
+                name: targetName,
+                dependencies: [
+                    .product(name: "OpenAPIRuntime", package: "swift-openapi-runtime"),
+                    .product(name: "OpenAPIURLSession", package: "swift-openapi-urlsession"),
+                ],
+                path: "Sources/\(rawValue)",
+                exclude: [
+                    "openapi-generator-config.yml",
+                    "openapi.yml",
+                ]
+            )
+        } else {
+            return .binaryTarget(
+                name: targetName,
+                path: "XCFrameworks/\(targetName).zip")
+        }
     }
 
-    var testTarget: PackageDescription.Target {
+    var testTarget: PackageDescription.Target? {
+        guard self == .users else { return nil }
+        let dependencies: [Target.Dependency] = [
+            .product(name: "OpenAPIRuntime", package: "swift-openapi-runtime"),
+            .product(name: "OpenAPIURLSession", package: "swift-openapi-urlsession"),
+        ]
         let targetName = targetName
         return .testTarget(
             name: "UserTests",
-            dependencies: [.target(name: targetName)]
+            dependencies: dependencies + [
+                .target(name: targetName)
+            ]
         )
     }
-}
-
-let package = Package(
-    name: "GitHubRestAPISwiftOpenAPI",
-    platforms: [.macOS(.v10_15)],
-    products: GitHubRestAPIOpenAPITag.allCases.map(\.library),
-    dependencies: [
-        .package(url: "https://github.com/apple/swift-openapi-runtime", from: "1.0.0"),
-        .package(url: "https://github.com/apple/swift-openapi-urlsession", from: "1.0.0"),
-    ],
-    targets: GitHubRestAPIOpenAPITag.allCases.map(\.target) + [
-        GitHubRestAPIOpenAPITag.users.testTarget,
-    ]
-)
 
-let isBuildingDocC = ProcessInfo.processInfo.environment["GITHUB_PAGES"] == "true"
+    static var dependenciesTarget: PackageDescription.Target = .target(
+        name: "DependenciesTarget",
+        dependencies: [
+            .product(name: "OpenAPIRuntime", package: "swift-openapi-runtime"),
+            .product(name: "OpenAPIURLSession", package: "swift-openapi-urlsession"),
+        ],
+        path: "XCFrameworks/DependenciesTarget"
+    )
 
-// swift-docs is not needed for package users
-if isBuildingDocC {
-    package.dependencies += [
-        .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.3.0"),
-    ]
 }

XCFrameworks/DependenciesTarget/File.swift

@@ -0,0 +1,8 @@
+//
+//  File.swift
+//  
+//
+//  Created by zwc on 2024/1/2.
+//
+
+import Foundation