feat: add library product to Swift Package (#8)

Author: wojciech-kulik

Makefile

@@ -1,5 +1,5 @@
 EXECUTABLE=xcp
-BUILD_PRODUCT=XcodeProjectCLI
+BUILD_PRODUCT=xcp
 
 build:
 	swift build
@@ -45,4 +45,4 @@ make uninstall:
 clean:
 	rm -rf .bin .release .build
 	swift package clean
-	rm ~/.local/bin/$(EXECUTABLE)
+	rm ~/.local/bin/$(EXECUTABLE) || true

Package.swift

@@ -8,6 +8,10 @@ let package = Package(
     platforms: [
         .macOS(.v13)
     ],
+    products: [
+        .library(name: "XcodeProject", targets: ["XcodeProject"]),
+        .executable(name: "xcp", targets: ["XcodeProjectCLI"])
+    ],
     dependencies: [
         .package(url: "https://github.com/tuist/XcodeProj.git", .upToNextMajor(from: "8.12.0")),
         .package(url: "https://github.com/apple/swift-argument-parser", from: "1.5.0")
@@ -16,13 +20,24 @@ let package = Package(
         .executableTarget(
             name: "XcodeProjectCLI",
             dependencies: [
-                "XcodeProj",
+                "XcodeProjectCommands",
+                .product(name: "ArgumentParser", package: "swift-argument-parser")
+            ]
+        ),
+        .target(
+            name: "XcodeProject",
+            dependencies: ["XcodeProj"]
+        ),
+        .target(
+            name: "XcodeProjectCommands",
+            dependencies: [
+                "XcodeProject",
                 .product(name: "ArgumentParser", package: "swift-argument-parser")
             ]
         ),
         .testTarget(
-            name: "XcodeProjectCLITests",
-            dependencies: ["XcodeProjectCLI"]
+            name: "XcodeProjectCommandsTests",
+            dependencies: ["XcodeProjectCommands"]
         )
     ]
 )

README.md

@@ -67,6 +67,21 @@ brew install wojciech-kulik/tap/xcp
    xcp --version
    ```
 
+## ⚙️ Use as a Library
+
+You can also use XcodeProjectCLI as a library in your Swift projects for macOS. Here's a simple example of how to integrate it:
+
+```swift
+import XcodeProject
+
+let projectPath = "/path/to/YourProject.xcodeproj"
+let xcodeProject = try Project(xcodeProjectPath: projectPath)
+
+// Sample operation:
+try project.groups.addGroup("path/relative/to/xcodeproj/NewGroup".asInputPath)
+try project.save()
+```
+
 ## 🤓 My Other Projects
 
 - [Snippety](https://snippety.app) - Snippets manager for macOS & iOS

…urces/XcodeProjectCLI/Core/Project.swift Sources/XcodeProject/Core/Project.swiftSources/XcodeProjectCLI/Core/Project.swift renamed to Sources/XcodeProject/Core/Project.swift Sources/XcodeProjectCLI/Core/Project.swift renamed to Sources/XcodeProject/Core/Project.swift

@@ -1,25 +1,27 @@
 import Foundation
 import XcodeProj
 
-final class Project {
+public final class Project {
     private(set) static var projectRoot = ""
 
-    let targets: ProjectTargets
-    let groups: ProjectGroups
-    let files: ProjectFiles
+    public let targets: ProjectTargets
+    public let groups: ProjectGroups
+    public let files: ProjectFiles
 
     private let project: XcodeProj
 
-    init(projectPath: String?) throws {
-        var projectPath = projectPath
+    public init(xcodeProjectPath: String?) throws {
+        var projectPath = xcodeProjectPath
+        let pwd = ProcessInfo.processInfo.environment["PWD"]
+        var currentDir = pwd
 
         #if DEBUG
-        let currentDir: String? = ProcessInfo.processInfo.environment["PWD"] ?? #filePath
-            .components(separatedBy: "/")
-            .dropLast(4)
-            .joined(separator: "/")
-        #else
-        let currentDir = ProcessInfo.processInfo.environment["PWD"]
+        if pwd == nil || pwd == "/tmp" {
+            currentDir = #filePath
+                .components(separatedBy: "/")
+                .dropLast(4)
+                .joined(separator: "/")
+        }
         #endif
 
         if projectPath == nil, let currentDir {
@@ -33,7 +35,7 @@ final class Project {
         projectPath = (projectPath as NSString?)?.expandingTildeInPath
 
         guard let projectPath else {
-            throw CLIError.xcodeProjectNotFound
+            throw XcodeProjectError.xcodeProjectNotFound
         }
 
         Self.projectRoot = (projectPath as NSString).deletingLastPathComponent
@@ -44,7 +46,7 @@ final class Project {
         self.files = ProjectFiles(project: project)
     }
 
-    func save() throws {
+    public func save() throws {
         if let path = project.path {
             try project.write(path: path, override: true)
         }

…/XcodeProjectCLI/Core/ProjectFiles.swift …ces/XcodeProject/Core/ProjectFiles.swiftSources/XcodeProjectCLI/Core/ProjectFiles.swift renamed to Sources/XcodeProject/Core/ProjectFiles.swift Sources/XcodeProjectCLI/Core/ProjectFiles.swift renamed to Sources/XcodeProject/Core/ProjectFiles.swift

@@ -1,7 +1,7 @@
 import Foundation
 import XcodeProj
 
-final class ProjectFiles {
+public final class ProjectFiles {
     private let project: XcodeProj
     private lazy var projectGroups = ProjectGroups(project: project)
     private lazy var projectTargets = ProjectTargets(project: project)
@@ -10,13 +10,17 @@ final class ProjectFiles {
         self.project = project
     }
 
-    func findFile(_ filePath: InputPath) -> PBXFileReference? {
+    public init(xcodeProjectPath: String) throws {
+        self.project = try XcodeProj(pathString: xcodeProjectPath)
+    }
+
+    public func findFile(_ filePath: InputPath) -> PBXFileReference? {
         project.pbxproj.fileReferences
             .first { $0.fullPath == filePath }
     }
 
     @discardableResult
-    func addFile(
+    public func addFile(
         _ filePath: InputPath,
         toTargets targets: [String],
         guessTarget: Bool,
@@ -28,7 +32,7 @@ final class ProjectFiles {
 
         // Validate group
         if group == nil, !createGroups {
-            throw CLIError.groupNotFoundInProject(groupPath)
+            throw XcodeProjectError.groupNotFoundInProject(groupPath)
         }
 
         // Create group if needed
@@ -59,9 +63,9 @@ final class ProjectFiles {
         return targets
     }
 
-    func removeFile(_ filePath: InputPath) throws {
+    public func removeFile(_ filePath: InputPath) throws {
         guard let fileRef = findFile(filePath) else {
-            throw CLIError.fileNotFoundInProject(filePath)
+            throw XcodeProjectError.fileNotFoundInProject(filePath)
         }
 
         // Remove from build phases
@@ -80,7 +84,7 @@ final class ProjectFiles {
         project.pbxproj.delete(object: fileRef)
     }
 
-    func removeFile(_ filePath: InputPath, from target: String) throws {
+    public func removeFile(_ filePath: InputPath, from target: String) throws {
         guard let target = project.pbxproj.targets(named: target).first else {
             return
         }
@@ -90,11 +94,11 @@ final class ProjectFiles {
     }
 
     @discardableResult
-    func moveFile(_ filePath: InputPath, to newPath: InputPath) throws -> [TargetName] {
+    public func moveFile(_ filePath: InputPath, to newPath: InputPath) throws -> [TargetName] {
         let targets = try projectTargets.findTargets(for: filePath)
 
         guard let fileRef = findFile(filePath) else {
-            throw CLIError.fileNotFoundInProject(filePath)
+            throw XcodeProjectError.fileNotFoundInProject(filePath)
         }
 
         // Find or create destination group
@@ -117,9 +121,9 @@ final class ProjectFiles {
         return targets.map(\.name)
     }
 
-    func renameFile(_ filePath: InputPath, newName: String) throws {
+    public func renameFile(_ filePath: InputPath, newName: String) throws {
         guard let file = findFile(filePath) else {
-            throw CLIError.fileNotFoundInProject(filePath)
+            throw XcodeProjectError.fileNotFoundInProject(filePath)
         }
 
         file.name = nil

…XcodeProjectCLI/Core/ProjectGroups.swift …es/XcodeProject/Core/ProjectGroups.swiftSources/XcodeProjectCLI/Core/ProjectGroups.swift renamed to Sources/XcodeProject/Core/ProjectGroups.swift Sources/XcodeProjectCLI/Core/ProjectGroups.swift renamed to Sources/XcodeProject/Core/ProjectGroups.swift

@@ -1,23 +1,27 @@
 import Foundation
 import XcodeProj
 
-final class ProjectGroups {
+public final class ProjectGroups {
     private let project: XcodeProj
     private lazy var projectFiles = ProjectFiles(project: project)
 
     init(project: XcodeProj) {
         self.project = project
     }
 
-    func findGroup(_ groupPath: InputPath) throws -> PBXGroup? {
+    public init(xcodeProjectPath: String) throws {
+        self.project = try XcodeProj(pathString: xcodeProjectPath)
+    }
+
+    public func findGroup(_ groupPath: InputPath) throws -> PBXGroup? {
         try listAllGroups()
             .first { $1 == groupPath }?
             .group
     }
 
-    func createGroupHierarchy(at groupPath: InputPath) throws -> PBXGroup {
+    public func createGroupHierarchy(at groupPath: InputPath) throws -> PBXGroup {
         guard let rootGroup = try project.pbxproj.rootGroup() else {
-            throw CLIError.rootGroupNotFound
+            throw XcodeProjectError.rootGroupNotFound
         }
 
         let pathComponents = groupPath.relativePathComponents
@@ -34,7 +38,7 @@ final class ProjectGroups {
         return currentGroup
     }
 
-    func addGroup(_ groupPath: InputPath) throws {
+    public func addGroup(_ groupPath: InputPath) throws {
         if try findGroup(groupPath) != nil {
             print("Warning: Group already exists in the project: \(groupPath)")
             return
@@ -43,19 +47,19 @@ final class ProjectGroups {
         _ = try createGroupHierarchy(at: groupPath)
     }
 
-    func renameGroup(_ groupPath: InputPath, newName: String) throws {
+    public func renameGroup(_ groupPath: InputPath, newName: String) throws {
         guard let group = try findGroup(groupPath) else {
-            throw CLIError.groupNotFoundInProject(groupPath)
+            throw XcodeProjectError.groupNotFoundInProject(groupPath)
         }
 
         group.name = nil
         group.path = newName
         group.setGroupSourceTree()
     }
 
-    func deleteGroup(_ groupPath: InputPath) throws {
+    public func deleteGroup(_ groupPath: InputPath) throws {
         guard let group = try findGroup(groupPath) else {
-            throw CLIError.groupNotFoundInProject(groupPath)
+            throw XcodeProjectError.groupNotFoundInProject(groupPath)
         }
 
         if let parent = group.parent as? PBXGroup {
@@ -65,9 +69,9 @@ final class ProjectGroups {
         try removeGroupRecursively(group)
     }
 
-    func moveGroup(_ groupPath: InputPath, to destination: InputPath) throws {
+    public func moveGroup(_ groupPath: InputPath, to destination: InputPath) throws {
         guard let group = try findGroup(groupPath) else {
-            throw CLIError.groupNotFoundInProject(groupPath)
+            throw XcodeProjectError.groupNotFoundInProject(groupPath)
         }
 
         if let parent = group.parent as? PBXGroup {
@@ -139,7 +143,7 @@ final class ProjectGroups {
 
     private func listAllGroups() throws -> [(group: PBXGroup, path: InputPath)] {
         guard let rootGroup = try project.pbxproj.rootGroup() else {
-            throw CLIError.rootGroupNotFound
+            throw XcodeProjectError.rootGroupNotFound
         }
 
         return try rootGroup