implemented runscript plugin

Author: p-x9

.gitignore

@@ -7,3 +7,6 @@ DerivedData/
 .swiftpm/config/registries.json
 .swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
 .netrc
+
+run-script-bin.artifactbundle
+run-script-bin.artifactbundle.zip

Package.resolved

@@ -1,28 +1,36 @@
 // swift-tools-version: 5.7
-// The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
 
 let package = Package(
     name: "RunScriptPlugin",
     products: [
-        // Products define the executables and libraries a package produces, and make them visible to other packages.
-        .library(
+        .plugin(
             name: "RunScriptPlugin",
-            targets: ["RunScriptPlugin"]),
+            targets: ["RunScriptPlugin"]
+        ),
+        .executable(
+            name: "run-script",
+            targets: ["run-script"]
+        )
     ],
     dependencies: [
-        // Dependencies declare other packages that this package depends on.
-        // .package(url: /* package url */, from: "1.0.0"),
+        .package(url: "https://github.com/jpsim/Yams.git", from: "5.0.1")
     ],
     targets: [
-        // Targets are the basic building blocks of a package. A target can define a module or a test suite.
-        // Targets can depend on other targets in this package, and on products in packages this package depends on.
-        .target(
+        .executableTarget(
+            name: "run-script",
+            dependencies: [
+                .product(name: "Yams", package: "Yams")
+            ]
+        ),
+        .binaryTarget(name: "run-script-bin", path: "./run-script-bin.artifactbundle.zip"),
+        .plugin(
             name: "RunScriptPlugin",
-            dependencies: []),
-        .testTarget(
-            name: "RunScriptPluginTests",
-            dependencies: ["RunScriptPlugin"]),
+            capability: .buildTool(),
+            dependencies: [
+                "run-script-bin"
+            ]
+        )
     ]
 )

Package.swift

@@ -0,0 +1,94 @@
+//
+//  plugin.swift
+//  
+//
+//  Created by p-x9 on 2023/02/04.
+//  
+//
+
+import Foundation
+import PackagePlugin
+
+@main
+struct RunScriptPlugin: BuildToolPlugin {
+    func createBuildCommands(context: PackagePlugin.PluginContext, target: PackagePlugin.Target) async throws -> [PackagePlugin.Command] {
+        createBuildCommands(
+            packageDirectory: context.package.directory,
+            workingDirectory: context.pluginWorkDirectory,
+            tool: try context.tool(named: "run-script-bin")
+        )
+    }
+
+    private func createBuildCommands(
+        packageDirectory: Path,
+        workingDirectory: Path,
+        tool: PluginContext.Tool
+    ) -> [Command] {
+        guard let configuration = packageDirectory.firstConfigurationFileInParentDirectories() else {
+            return []
+        }
+
+        let arguments = [configuration.string]
+
+        return [
+            .prebuildCommand(
+                displayName: "RunScriptPlugin(PreBuild)",
+                executable: tool.path,
+                arguments: arguments + ["1"],
+                outputFilesDirectory: workingDirectory
+            ),
+            .buildCommand(
+                displayName: "RunScriptPlugin(Build)",
+                executable: tool.path,
+                arguments: arguments + ["0"]
+            )
+        ]
+    }
+}
+
+#if canImport(XcodeProjectPlugin)
+import XcodeProjectPlugin
+
+extension RunScriptPlugin: XcodeBuildToolPlugin {
+    func createBuildCommands(context: XcodePluginContext, target: XcodeTarget) throws -> [Command] {
+        return createBuildCommands(
+            packageDirectory: context.xcodeProject.directory,
+            workingDirectory: context.pluginWorkDirectory,
+            tool: try context.tool(named: "run-script-bin")
+        )
+    }
+}
+#endif
+
+// ref: https://github.com/realm/SwiftLint/blob/main/Plugins/SwiftLintPlugin/Path%2BHelpers.swift
+extension Path {
+    func firstConfigurationFileInParentDirectories() -> Path? {
+        let defaultConfigurationFileName = ".runscript.yml"
+        let proposedDirectory = sequence(
+            first: self,
+            next: { path in
+                guard path.stem.count > 1 else {
+                    // Check we're not at the root of this filesystem, as `removingLastComponent()`
+                    // will continually return the root from itself.
+                    return nil
+                }
+
+                return path.removingLastComponent()
+            }
+        ).first { path in
+            let potentialConfigurationFile = path.appending(subpath: defaultConfigurationFileName)
+            return potentialConfigurationFile.isAccessible()
+        }
+        return proposedDirectory?.appending(subpath: defaultConfigurationFileName)
+    }
+
+    /// Safe way to check if the file is accessible from within the current process sandbox.
+    private func isAccessible() -> Bool {
+        let result = string.withCString { pointer in
+            access(pointer, R_OK)
+        }
+
+        return result == 0
+    }
+}
+

Plugins/RunScriptPlugin/plugin.swift

@@ -0,0 +1,23 @@
+//
+//  Config.swift
+//  
+//
+//  Created by p-x9 on 2023/02/04.
+//  
+//
+
+import Foundation
+
+struct Config: Codable {
+    let prebuild: [Script]?
+    let build: [Script]?
+}
+
+struct Script: Codable {
+    let name: String?
+
+    let launchPath: String?
+
+    let path: String?
+    let script: String?
+}

Sources/RunScriptPlugin/RunScriptPlugin.swift

@@ -0,0 +1,69 @@
+//
+//  main.swift
+//  
+//
+//  Created by p-x9 on 2023/02/04.
+//  
+//
+
+import Foundation
+import Yams
+
+#if os(macOS)
+enum CommandError: LocalizedError {
+    case invalidArguments
+}
+
+func run() throws {
+    let arguments = ProcessInfo().arguments
+
+    guard arguments.count == 3 else {
+        throw CommandError.invalidArguments
+    }
+
+    let configFilePath = arguments[1]
+    let configFileURL = URL(fileURLWithPath: configFilePath)
+
+    let isPrebuild: Bool = arguments[2] == "1"
+
+    let fileManager = FileManager.default
+    let decoder = YAMLDecoder()
+
+    guard fileManager.fileExists(atPath: configFilePath) else {
+        return
+    }
+
+    let data = try Data(contentsOf: configFileURL)
+    let config = try decoder.decode(Config.self, from: data)
+
+    let directory = configFileURL.deletingLastPathComponent().path
+    FileManager.default.changeCurrentDirectoryPath(directory)
+
+    let scripts = isPrebuild ? config.prebuild : config.build
+    try scripts?.forEach {
+        try run($0)
+    }
+}
+
+func run(_ script: Script) throws {
+    let process = Process()
+
+    process.launchPath = "/bin/sh"
+
+    if let path = script.path {
+        process.arguments = [path]
+    } else if let script = script.script {
+        process.arguments = ["-c", script]
+    }
+
+    process.launch()
+    process.waitUntilExit()
+}
+
+do {
+    try run()
+    exit(0)
+} catch {
+    exit(1)
+}
+#endif

Sources/run-script/Config.swift

@@ -0,0 +1,69 @@
+#!/usr/bin/env bash
+
+# example
+#
+# - version
+# scripts/create_artifactbundle.sh 1.0.0
+#
+# - version with artifactbundle name
+# scripts/create_artifactbundle.sh 1.0.0 run-script-bin
+
+set -Ceu
+
+VERSION_STRING=$1
+
+PRODUCT_NAME="run-script"
+NAME=$PRODUCT_NAME
+
+if (( $# > 1 )); then
+    NAME=$2
+fi
+
+ARTIFACT_BUNDLE_NAME="${NAME}.artifactbundle"
+ARTIFACT_BUNDLE_BIN_PATH="${ARTIFACT_BUNDLE_NAME}/${NAME}/bin"
+
+INFO_TEMPLATE="./scripts/info.json.template"
+
+show_checksum() {
+    CHECKSUM=$(swift package compute-checksum ./${ARTIFACT_BUNDLE_NAME}.zip)
+    echo "checksum:"
+    echo ${CHECKSUM}
+}
+
+create_artifact_bundle() {
+    mkdir -p "${ARTIFACT_BUNDLE_BIN_PATH}"
+
+    sed "s/__VERSION__/${VERSION_STRING}/g; s/__NAME__/${NAME}/g" ${INFO_TEMPLATE} > "${ARTIFACT_BUNDLE_NAME}/info.json"
+
+    cp -f ".build/apple/Products/Release/${PRODUCT_NAME}" "${ARTIFACT_BUNDLE_BIN_PATH}"
+#    cp -f LICENSE "${ARTIFACT_BUNDLE_NAME}"
+
+    mv "${ARTIFACT_BUNDLE_BIN_PATH}/${PRODUCT_NAME}" "${ARTIFACT_BUNDLE_BIN_PATH}/${NAME}"
+}
+
+zip_artifact_bundle() {
+    zip -yr - "${ARTIFACT_BUNDLE_NAME}" > "./${ARTIFACT_BUNDLE_NAME}.zip"
+}
+
+build_target() {
+    swift build -c release --product $PRODUCT_NAME --arch arm64 --arch x86_64
+}
+
+clear_outputs() {
+    rm -rf $ARTIFACT_BUNDLE_NAME
+    rm -f "${ARTIFACT_BUNDLE_NAME}.zip"
+}
+
+
+clear_outputs
+
+if [ "$1" = "--clear" ]; then
+    exit
+fi
+
+build_target
+create_artifact_bundle
+zip_artifact_bundle
+
+show_checksum
+

Sources/run-script/main.swift

@@ -0,0 +1,18 @@
+{
+  "schemaVersion": "1.0",
+  "artifacts": {
+    "__NAME__": {
+      "version": "__VERSION__",
+      "type": "executable",
+      "variants": [
+        {
+          "path": "__NAME__/bin/__NAME__",
+          "supportedTriples": [
+            "x86_64-apple-macosx",
+            "arm64-apple-macosx"
+          ]
+        }
+      ]
+    }
+  }
+}