Returns Xcode.Project from generate()

Sources/Commands/SwiftPackageTool.swift

@@ -162,13 +162,13 @@ public class SwiftPackageTool: SwiftTool<PackageToolOptions> {
                 dstdir = try getPackageRoot()
                 projectName = graph.rootPackages[0].name
             }
-            let outpath = try Xcodeproj.generate(
-                outputDir: dstdir,
+            let xcodeprojPath = Xcodeproj.buildXcodeprojPath(outputDir: dstdir, projectName: projectName)
+            try Xcodeproj.generate(
                 projectName: projectName,
+                xcodeprojPath: xcodeprojPath,
                 graph: graph,
                 options: options.xcodeprojOptions)
-
-            print("generated:", outpath.prettyPath(cwd: originalWorkingDirectory))
+            print("generated:", xcodeprojPath.prettyPath(cwd: originalWorkingDirectory))
 
         case .describe:
             let graph = try loadPackageGraph()

Sources/Xcodeproj/generate().swift

@@ -38,26 +38,28 @@ public struct XcodeprojOptions {
     }
 }
 
+// Determine the path of the .xcodeproj wrapper directory.
+public func buildXcodeprojPath(outputDir: AbsolutePath, projectName: String) -> AbsolutePath {
+    let xcodeprojName = "\(projectName).xcodeproj"
+    return outputDir.appending(RelativePath(xcodeprojName))
+}
+
 /// Generates an Xcode project and all needed support files.  The .xcodeproj
-/// wrapper directory is created in the path specified by `outputDir`, basing
-/// the file name on the project name `projectName`.  Returns the path of the
-/// generated project.  All ancillary files will be generated inside of the
-/// .xcodeproj wrapper directory.
+/// wrapper directory is created to the path specified by `xcodeprojPath`
+/// Returns the generated project.  All ancillary files will
+/// be generated inside of the .xcodeproj wrapper directory.
+@discardableResult
 public func generate(
-    outputDir: AbsolutePath,
     projectName: String,
+    xcodeprojPath: AbsolutePath,
     graph: PackageGraph,
     options: XcodeprojOptions
-) throws -> AbsolutePath {
+) throws -> Xcode.Project {
     // Note that the output directory might be completely separate from the
     // path of the root package (which is where the sources live).
 
     let srcroot = graph.rootPackages[0].path
 
-    // Determine the path of the .xcodeproj wrapper directory.
-    let xcodeprojName = "\(projectName).xcodeproj"
-    let xcodeprojPath = outputDir.appending(RelativePath(xcodeprojName))
-
     // Determine the path of the scheme directory (it's inside the .xcodeproj).
     let schemesDir = xcodeprojPath.appending(components: "xcshareddata", "xcschemes")
 
@@ -70,10 +72,13 @@ public func generate(
     let extraDirs = try findDirectoryReferences(path: srcroot)
 
     /// Generate the contents of project.xcodeproj (inside the .xcodeproj).
+    // FIXME: This could be more efficient by directly writing to a stream
+    // instead of first creating a string.
+    let project = try pbxproj(xcodeprojPath: xcodeprojPath, graph: graph, extraDirs: extraDirs, options: options)
     try open(xcodeprojPath.appending(component: "project.pbxproj")) { stream in
-        // FIXME: This could be more efficient by directly writing to a stream
-        // instead of first creating a string.
-        let str = try pbxproj(xcodeprojPath: xcodeprojPath, graph: graph, extraDirs: extraDirs, options: options)
+        // Serialize the project model we created to a plist, and return
+        // its string description.
+        let str = "// !$*UTF8*$!\n" + project.generatePlist().description
         stream(str)
     }
 
@@ -144,7 +149,7 @@ public func generate(
         }
     }
 
-    return xcodeprojPath
+    return project
 }
 
 /// Writes the contents to the file specified.

Sources/Xcodeproj/pbxproj().swift

@@ -34,16 +34,13 @@ public func pbxproj(
         extraDirs: [AbsolutePath],
         options: XcodeprojOptions,
         fileSystem: FileSystem = localFileSystem
-    ) throws -> String {
-    let project = try xcodeProject(
+    ) throws -> Xcode.Project {
+    return try xcodeProject(
         xcodeprojPath: xcodeprojPath,
         graph: graph,
         extraDirs: extraDirs,
         options: options,
         fileSystem: fileSystem)
-    // Serialize the project model we created to a plist, and return
-    // its string description.
-    return "// !$*UTF8*$!\n" + project.generatePlist().description
 }
 
 /// A set of c99 target names that are invalid for Xcode Framework targets.

Tests/XcodeprojTests/GenerateXcodeprojTests.swift

@@ -18,6 +18,14 @@ import Utility
 import XCTest
 
 class GenerateXcodeprojTests: XCTestCase {
+    func testBuildXcodeprojPath() {
+        let outdir = AbsolutePath("/path/to/project")
+        let projectName = "Bar"
+        let xcodeprojPath = Xcodeproj.buildXcodeprojPath(outputDir: outdir, projectName: projectName)
+        let expectedPath = AbsolutePath("/path/to/project/Bar.xcodeproj")
+        XCTAssertEqual(xcodeprojPath, expectedPath)
+    }
+
     func testXcodebuildCanParseIt() {
       #if os(macOS)
         mktmpdir { dstdir in
@@ -28,7 +36,8 @@ class GenerateXcodeprojTests: XCTestCase {
             XCTAssertFalse(diagnostics.hasErrors)
 
             let projectName = "DummyProjectName"
-            let outpath = try Xcodeproj.generate(outputDir: dstdir, projectName: projectName, graph: graph, options: XcodeprojOptions())
+            let outpath = Xcodeproj.buildXcodeprojPath(outputDir: dstdir, projectName: projectName)
+            try Xcodeproj.generate(projectName: projectName, xcodeprojPath: outpath, graph: graph, options: XcodeprojOptions())
 
             XCTAssertDirectoryExists(outpath)
             XCTAssertEqual(outpath, dstdir.appending(component: projectName + ".xcodeproj"))