Merge pull request #6 from cybozu/output-message

Warning text is now displayed in Xcode

Author: Kyome22

Package.swift

@@ -10,7 +10,7 @@ let package = Package(
     products: [
         .executable(
             name: "license-checker",
-            targets: ["LicenseChecker"]
+            targets: ["license-checker"]
         ),
         .plugin(
             name: "LicenseCheckerPlugin",
@@ -26,7 +26,7 @@ let package = Package(
     targets: [
         .target(name: "LicenseCheckerModule"),
         .executableTarget(
-            name: "LicenseChecker",
+            name: "license-checker",
             dependencies: [
                 .target(name: "LicenseCheckerModule"),
                 .product(
@@ -52,15 +52,15 @@ let package = Package(
         .testTarget(
             name: "LicenseCheckerTests",
             dependencies: [
-                .target(name: "LicenseChecker"),
+                .target(name: "license-checker"),
                 .target(name: "TestResources")
             ]
         ),
         .plugin(
             name: "LicenseCheckerPlugin",
             capability: .buildTool(),
             dependencies: [
-                .target(name: "LicenseChecker")
+                .target(name: "license-checker")
             ]
         )
     ]

Plugins/LicenseCheckerPlugin/main.swift

@@ -4,7 +4,7 @@ import PackagePlugin
 @main
 struct LicenseCheckerPlugin: BuildToolPlugin {
     struct SourcePackagesNotFoundError: Error & CustomStringConvertible {
-        let description: String = "SourcePackages not found"
+        let description: String = "error: SourcePackages not found"
     }
 
     func sourcePackages(_ pluginWorkDirectory: Path) throws -> Path {
@@ -19,7 +19,7 @@ struct LicenseCheckerPlugin: BuildToolPlugin {
     }
 
     func createBuildCommands(context: PluginContext, target: Target) async throws -> [Command] {
-        let executablePath = try context.tool(named: "LicenseChecker").path
+        let executablePath = try context.tool(named: "license-checker").path
         let sourcePackagesPath = try sourcePackages(context.pluginWorkDirectory)
         let whiteListPath = context.package.directory.appending(subpath: "white-list.json")
 
@@ -48,7 +48,7 @@ import XcodeProjectPlugin
 /// This command works with `Run Build Tool Plug-ins` in Xcode `Build Phase`.
 extension LicenseCheckerPlugin: XcodeBuildToolPlugin {
     func createBuildCommands(context: XcodePluginContext, target: XcodeTarget) throws -> [Command] {
-        let executablePath = try context.tool(named: "LicenseChecker").path
+        let executablePath = try context.tool(named: "license-checker").path
         let sourcePackagesPath = try sourcePackages(context.pluginWorkDirectory)
         let whiteListPath = context.xcodeProject.directory.appending(subpath: "white-list.json")
 

Sources/LicenseCheckerModule/LCError.swift

@@ -1,18 +1,26 @@
 import Foundation
 
-public enum LCError: Error, LocalizedError {
+public enum LCError: LocalizedError {
     case notLoadedWorkspaceState
     case notLoadedWhiteList
     case forbiddenLibraryFound
 
     public var errorDescription: String? {
         switch self {
         case .notLoadedWorkspaceState:
-            return "🚨 Couldn't load workspace-state.json"
+            "Couldn't load workspace-state.json"
         case .notLoadedWhiteList:
-            return "🚨 Couldn't load white-list.json"
+            "Couldn't load white-list.json"
         case .forbiddenLibraryFound:
-            return "🚨 Library with forbidden license is found."
+            "Library with forbidden license is found."
+        }
+    }
+
+    public var exitCode: Int32 {
+        switch self {
+        case .notLoadedWorkspaceState: 1
+        case .notLoadedWhiteList: 2
+        case .forbiddenLibraryFound: 3
         }
     }
 }

Sources/LicenseChecker/LicenseChecker.swift renamed to Sources/license-checker/LicenseChecker.swift

@@ -1,4 +1,5 @@
 import ArgumentParser
+import Darwin
 import LicenseCheckerModule
 
 struct LicenseChecker: ParsableCommand {
@@ -21,9 +22,14 @@ struct LicenseChecker: ParsableCommand {
     var whiteListPath: String
 
     mutating func run() throws {
-        try LCMain().run(
-            sourcePackagesPath: self.sourcePackagesPath,
-            whiteListPath: self.whiteListPath
-        )
+        do {
+            try LCMain().run(
+                sourcePackagesPath: self.sourcePackagesPath,
+                whiteListPath: self.whiteListPath
+            )
+        } catch let error as LCError {
+            Swift.print("error:", error.errorDescription!)
+            Darwin.exit(error.exitCode)
+        }
     }
 }

Sources/LicenseChecker/main.swift renamed to Sources/license-checker/main.swift

@@ -175,7 +175,7 @@ final class LicenseCheckerTests: XCTestCase {
         let data = pipe.fileHandleForReading.readDataToEndOfFile()
         let output = try XCTUnwrap(String(data: data, encoding: .utf8))
 
-        XCTAssertTrue(output.hasSuffix("🚨 Couldn't load workspace-state.json\n"))
+        XCTAssertTrue(output.hasSuffix("error: Couldn't load workspace-state.json\n"))
         XCTAssertEqual(process.terminationStatus, 1)
     }
 
@@ -194,7 +194,7 @@ final class LicenseCheckerTests: XCTestCase {
         let data = pipe.fileHandleForReading.readDataToEndOfFile()
         let output = try XCTUnwrap(String(data: data, encoding: .utf8))
 
-        XCTAssertTrue(output.hasSuffix("🚨 Couldn't load white-list.json\n"))
+        XCTAssertTrue(output.hasSuffix("error: Couldn't load white-list.json\n"))
         XCTAssertEqual(process.terminationStatus, 1)
     }
 
@@ -213,7 +213,7 @@ final class LicenseCheckerTests: XCTestCase {
         let data = pipe.fileHandleForReading.readDataToEndOfFile()
         let output = try XCTUnwrap(String(data: data, encoding: .utf8))
 
-        XCTAssertTrue(output.hasSuffix("🚨 Library with forbidden license is found.\n"))
+        XCTAssertTrue(output.hasSuffix("error: Library with forbidden license is found.\n"))
         XCTAssertEqual(process.terminationStatus, 1)
     }
 }