Support for the change of indexStorePath for Xcode 14 (#523)

Author: GetToSet

CHANGELOG.md

@@ -7,6 +7,7 @@
 ##### Enhancements
 
 - Add `--report-include` option to filter reported violations with an allowlist.
+- Support for reading Xcode 14 generated index stores.
 
 ##### Bug Fixes
 

README.md

@@ -408,7 +408,7 @@ Note that when using `--skip-build` and `--index-store-path` it's vital that the
 
 ### Xcode
 
-The index store generated by `xcodebuild` exists in DerivedData at a location dependent on your project, e.g `~/Library/Developer/Xcode/DerivedData/YourProject-abc123/Index/DataStore`.
+The index store generated by `xcodebuild` exists in DerivedData at a location dependent on your project, e.g `~/Library/Developer/Xcode/DerivedData/YourProject-abc123/Index/DataStore`. For Xcode 14 and later, the `Index` directory can be found as `Index.noindex`, which suppresses Spotlight indexing.
 
 ### SwiftPM
 

Sources/Shared/PeripheryError.swift

@@ -19,6 +19,7 @@ public enum PeripheryError: Error, LocalizedError, CustomStringConvertible {
     case swiftVersionUnsupportedError(version: String, minimumVersion: String)
     case unindexedTargetsError(targets: Set<String>, indexStorePath: String)
     case jsonDeserializationError(error: Error, json: String)
+    case indexStoreNotFound(derivedDataPath: String)
 
     public var errorDescription: String? {
         switch self {
@@ -65,6 +66,8 @@ public enum PeripheryError: Error, LocalizedError, CustomStringConvertible {
             return "This version of Periphery only supports Swift >= \(minimumVersion), you're using \(version)."
         case let .jsonDeserializationError(error, json):
             return "JSON deserialization failed: \(describe(error))\nJSON:\n\(json)"
+        case let .indexStoreNotFound(derivedDataPath):
+            return "Failed to find index datastore at path: \(derivedDataPath)"
         }
     }
 

Sources/XcodeSupport/Xcodebuild.swift

@@ -51,7 +51,15 @@ public final class Xcodebuild: Injectable {
     }
 
     func indexStorePath(project: XcodeProjectlike, schemes: [XcodeScheme]) throws -> String {
-        (try derivedDataPath(for: project, schemes: schemes).appending("Index/DataStore")).string
+        let derivedDataPath = try derivedDataPath(for: project, schemes: schemes)
+        let pathsToTry = ["Index/DataStore", "Index.noindex/DataStore"]
+            .map { derivedDataPath.appending($0).string }
+        guard let path = pathsToTry.first(where: { path in
+            return FileManager.default.fileExists(atPath: path)
+        }) else {
+            throw PeripheryError.indexStoreNotFound(derivedDataPath: derivedDataPath.string)
+        }
+        return path
     }
 
     func schemes(project: XcodeProjectlike) throws -> [String] {