Ignore non-source files from .gitignore, add root level files.

Author: ViktorSimko

Sources/SourceControl/GitRepository.swift

@@ -391,6 +391,16 @@ public class GitRepository: Repository, WorkingCheckout {
         return localFileSystem.isDirectory(AbsolutePath(firstLine))
     }
 
+    public func getIgnoredFiles() -> [AbsolutePath] {
+        return queue.sync {
+            let result = try? Process.checkNonZeroExit(
+                args: Git.tool, "-C", path.asString, "ls-files", "-o", "-i", "--exclude-standard").chomp()
+            return result?.split(separator: "\n").map(String.init).map {
+                return path.appending(RelativePath($0))
+            } ?? []
+        }
+    }
+
     // MARK: Git Operations
 
     /// Resolve a "treeish" to a concrete hash.

Sources/SourceControl/InMemoryGitRepository.swift

@@ -268,6 +268,10 @@ extension InMemoryGitRepository: WorkingCheckout {
     public func isAlternateObjectStoreValid() -> Bool {
         return true
     }
+
+    public func getIgnoredFiles() -> [AbsolutePath] {
+        return []
+    }
 }
 
 /// This class implement provider for in memeory git repository.

Sources/SourceControl/Repository.swift

@@ -203,6 +203,9 @@ public protocol WorkingCheckout {
 
     /// Returns true if there is an alternative store in the checkout and it is valid.
     func isAlternateObjectStoreValid() -> Bool
+
+    /// Returns the `AbsolutePath` of the files ignored by git.
+    func getIgnoredFiles() -> [AbsolutePath]
 }
 
 /// A single repository revision.

Sources/Xcodeproj/generate().swift

@@ -13,6 +13,7 @@ import POSIX
 import PackageGraph
 import PackageModel
 import PackageLoading
+import SourceControl
 import Utility
 
 public struct XcodeprojOptions {
@@ -47,6 +48,7 @@ public func generate(
     outputDir: AbsolutePath,
     projectName: String,
     graph: PackageGraph,
+    repositoryProvider: RepositoryProvider = GitRepositoryProvider(),
     options: XcodeprojOptions
 ) throws -> AbsolutePath {
     // Note that the output directory might be completely separate from the
@@ -69,10 +71,21 @@ public func generate(
     // references in the project.
     let extraDirs = try findDirectoryReferences(path: srcroot)
 
-    // Find non-source files in the source directories that should be added
+    // Find non-source files in the source directories and root that should be added
     // as a reference to the project.
-    var extraFiles = try findNonSourceFiles(path: srcroot.appending(component: "Sources"))
-    extraFiles.append(contentsOf: try findNonSourceFiles(path: srcroot.appending(component: "Tests")))
+    var extraFiles = try findNonSourceFiles(path: srcroot)
+    if let sourcesExtraFiles = try? findNonSourceFiles(path: srcroot.appending(component: "Sources"), recursively: true) {
+        extraFiles.append(contentsOf: sourcesExtraFiles)
+    }
+    if let testsExtraFiles = try? findNonSourceFiles(path: srcroot.appending(component: "Tests"), recursively: true) {
+        extraFiles.append(contentsOf: testsExtraFiles)
+    }
+
+    // Get the ignored files and exclude them
+    let ignoredFiles = try repositoryProvider.openCheckout(at: srcroot).getIgnoredFiles()
+    extraFiles = extraFiles.filter {
+        return !ignoredFiles.contains($0)
+    }
 
     /// Generate the contents of project.xcodeproj (inside the .xcodeproj).
     try open(xcodeprojPath.appending(component: "project.pbxproj")) { stream in
@@ -188,8 +201,8 @@ func findDirectoryReferences(path: AbsolutePath) throws -> [AbsolutePath] {
 }
 
 /// Finds the non-source files from `path` recursively
-func findNonSourceFiles(path: AbsolutePath) throws -> [AbsolutePath] {
-    let filesFromPath = try walk(path, recursively: true)
+func findNonSourceFiles(path: AbsolutePath, recursively: Bool = false) throws -> [AbsolutePath] {
+    let filesFromPath = try walk(path, recursively: recursively)
 
     return filesFromPath.filter {
         if !isFile($0) { return false }

Tests/XcodeprojTests/GenerateXcodeprojTests.swift

@@ -67,7 +67,7 @@ class GenerateXcodeprojTests: XCTestCase {
         let options = XcodeprojOptions(xcconfigOverrides: AbsolutePath("/doesntexist"))
         do {
             _ = try xcodeProject(xcodeprojPath: AbsolutePath.root.appending(component: "xcodeproj"),
-                                 graph: graph, extraDirs: [], options: options, fileSystem: fileSystem)
+                                 graph: graph, extraDirs: [], extraFiles: [], options: options, fileSystem: fileSystem)
             XCTFail("Project generation should have failed")
         } catch ProjectGenerationError.xcconfigOverrideNotFound(let path) {
             XCTAssertEqual(options.xcconfigOverrides, path)
@@ -85,7 +85,7 @@ class GenerateXcodeprojTests: XCTestCase {
         XCTAssertFalse(diagnostics.hasErrors)
 
         _ = try xcodeProject(xcodeprojPath: AbsolutePath.root.appending(component: "xcodeproj"),
-                             graph: graph, extraDirs: [], options: XcodeprojOptions(), fileSystem: fileSystem,
+                             graph: graph, extraDirs: [], extraFiles: [], options: XcodeprojOptions(), fileSystem: fileSystem,
                              warningStream: warningStream)
 
         let warnings = warningStream.bytes.asReadableString

Tests/XcodeprojTests/PackageGraphTests.swift

@@ -39,7 +39,7 @@ class PackageGraphTests: XCTestCase {
 
         let options = XcodeprojOptions(xcconfigOverrides: AbsolutePath("/Overrides.xcconfig"))
 
-        let project = try xcodeProject(xcodeprojPath: AbsolutePath.root.appending(component: "xcodeproj"), graph: g, extraDirs: [], options: options, fileSystem: fs)
+        let project = try xcodeProject(xcodeprojPath: AbsolutePath.root.appending(component: "xcodeproj"), graph: g, extraDirs: [], extraFiles: [], options: options, fileSystem: fs)
 
         XcodeProjectTester(project) { result in
             result.check(projectDir: "Bar")
@@ -149,7 +149,7 @@ class PackageGraphTests: XCTestCase {
                 products: [.library(name: "Bar", type: .dynamic, targets: ["Foo"])],
                 targets: [.target(name: "Foo")]),
         ], root: "/Foo", diagnostics: diagnostics, in: fs)
-        let project = try xcodeProject(xcodeprojPath: AbsolutePath("/Foo/build").appending(component: "xcodeproj"), graph: g, extraDirs: [], options: XcodeprojOptions(), fileSystem: fs)
+        let project = try xcodeProject(xcodeprojPath: AbsolutePath("/Foo/build").appending(component: "xcodeproj"), graph: g, extraDirs: [], extraFiles: [], options: XcodeprojOptions(), fileSystem: fs)
         XcodeProjectTester(project) { result in
             result.check(target: "Foo") { targetResult in
                 targetResult.check(productType: .framework)
@@ -175,7 +175,7 @@ class PackageGraphTests: XCTestCase {
       let g = loadMockPackageGraph([
           "/Bar": Package(name: "Bar", targets: [Target(name: "swift", dependencies: ["Sea", "Sea2"])]),
       ], root: "/Bar", diagnostics: diagnostics, in: fs)
-      let project = try xcodeProject(xcodeprojPath: AbsolutePath("/Bar/build").appending(component: "xcodeproj"), graph: g, extraDirs: [], options: XcodeprojOptions(), fileSystem: fs)
+      let project = try xcodeProject(xcodeprojPath: AbsolutePath("/Bar/build").appending(component: "xcodeproj"), graph: g, extraDirs: [], extraFiles: [], options: XcodeprojOptions(), fileSystem: fs)
 
       XcodeProjectTester(project) { result in
           result.check(target: "swift") { targetResult in
@@ -209,7 +209,7 @@ class PackageGraphTests: XCTestCase {
             "/Pkg": Package(name: "Pkg", targets: [Target(name: "LibraryTests", dependencies: ["Library", "HelperTool"])]),
             ], root: "/Pkg", diagnostics: diagnostics, in: fs)
 
-        let project = try xcodeProject(xcodeprojPath: AbsolutePath.root.appending(component: "xcodeproj"), graph: g, extraDirs: [], options: XcodeprojOptions(), fileSystem: fs)
+        let project = try xcodeProject(xcodeprojPath: AbsolutePath.root.appending(component: "xcodeproj"), graph: g, extraDirs: [], extraFiles: [], options: XcodeprojOptions(), fileSystem: fs)
 
         XcodeProjectTester(project) { result in
             result.check(projectDir: "Pkg")