First version of Public API

Package.swift

@@ -34,6 +34,7 @@ var targets: [PackageDescription.Target] = [
     .executableTarget(
         name: "Frontend",
         dependencies: [
+            .target(name: "Scan"),
             .target(name: "Shared"),
             .target(name: "Configuration"),
             .target(name: "SourceGraph"),
@@ -115,6 +116,18 @@ var targets: [PackageDescription.Target] = [
             .product(name: "FilenameMatcher", package: "swift-filename-matcher"),
         ]
     ),
+    .target(
+        name: "Scan",
+        dependencies: [
+            .target(name: "Configuration"),
+            .target(name: "Indexer"),
+            .target(name: "PeripheryKit"),
+            .target(name: "ProjectDrivers"),
+            .target(name: "Shared"),
+            .target(name: "SourceGraph"),
+            .target(name: "Logger"),
+        ]
+    ),
     .target(
         name: "TestShared",
         dependencies: [
@@ -178,7 +191,12 @@ let package = Package(
     platforms: [.macOS(.v13)],
     products: [
         .executable(name: "periphery", targets: ["Frontend"]),
-        .library(name: "PeripheryKit", targets: ["PeripheryKit"]),
+        .library(name: "PeripheryKit", targets: [
+            "SourceGraph",
+            "Configuration",
+            "ProjectDrivers",
+            "Scan",
+        ]),
     ],
     dependencies: dependencies,
     targets: targets,

Sources/Frontend/Commands/ScanCommand.swift

@@ -3,6 +3,8 @@ import Configuration
 import Foundation
 import Logger
 import PeripheryKit
+import ProjectDrivers
+import Scan
 import Shared
 import SystemPackage
 

Sources/Frontend/GuidedSetup.swift

@@ -1,6 +1,7 @@
 import Configuration
 import Foundation
 import Logger
+import ProjectDrivers
 import Shared
 
 #if canImport(XcodeSupport)

Sources/ProjectDrivers/GenericProjectDriver.swift

@@ -6,7 +6,7 @@ import Shared
 import SwiftIndexStore
 import SystemPackage
 
-public final class GenericProjectDriver {
+final class GenericProjectDriver {
     struct GenericConfig: Decodable {
         let indexstores: Set<String>
         let plists: Set<String>
@@ -24,7 +24,7 @@ public final class GenericProjectDriver {
     private let testTargets: Set<String>
     private let configuration: Configuration
 
-    public convenience init(genericProjectConfig: FilePath, configuration: Configuration) throws {
+    convenience init(genericProjectConfig: FilePath, configuration: Configuration) throws {
         guard genericProjectConfig.exists else {
             throw PeripheryError.pathDoesNotExist(path: genericProjectConfig.string)
         }

Sources/Frontend/Project.swift → Sources/ProjectDrivers/Project.swift

@@ -1,22 +1,50 @@
 import Configuration
 import Foundation
 import Logger
-import ProjectDrivers
 import Shared
 import SystemPackage
 
-final class Project {
+public final class Project {
     let kind: ProjectKind
 
     private let configuration: Configuration
     private let shell: Shell
     private let logger: Logger
 
-    convenience init(
+    public convenience init(
         configuration: Configuration,
         shell: Shell,
         logger: Logger
     ) throws {
+        try self.init(
+            kind: Self.detectKind(configuration: configuration),
+            configuration: configuration,
+            shell: shell,
+            logger: logger
+        )
+    }
+
+    // periphery:ignore
+    public init(configuration: Configuration) throws {
+        self.configuration = configuration
+        logger = Logger()
+        shell = Shell(logger: logger)
+        kind = try Self.detectKind(configuration: configuration)
+    }
+
+    public init(
+        kind: ProjectKind,
+        configuration: Configuration,
+        shell: Shell,
+        logger: Logger
+    ) {
+        self.kind = kind
+        self.configuration = configuration
+        self.shell = shell
+        self.logger = logger
+    }
+
+    static func detectKind(configuration: Configuration) throws -> ProjectKind {
         var kind: ProjectKind?
 
         if let path = configuration.project {
@@ -33,22 +61,10 @@ final class Project {
             throw PeripheryError.usageError("Failed to identify project in the current directory. For Xcode projects use the '--project' option, and for SPM projects change to the directory containing the Package.swift.")
         }
 
-        self.init(kind: kind, configuration: configuration, shell: shell, logger: logger)
-    }
-
-    init(
-        kind: ProjectKind,
-        configuration: Configuration,
-        shell: Shell,
-        logger: Logger
-    ) {
-        self.kind = kind
-        self.configuration = configuration
-        self.shell = shell
-        self.logger = logger
+        return kind
     }
 
-    func driver() throws -> ProjectDriver {
+    public func driver() throws -> ProjectDriver {
         switch kind {
         case let .xcode(projectPath):
             #if canImport(XcodeSupport)

Sources/Frontend/Scan.swift → Sources/Scan/Scan.swift

@@ -7,20 +7,31 @@ import ProjectDrivers
 import Shared
 import SourceGraph
 
-final class Scan {
+public final class Scan {
     private let configuration: Configuration
     private let logger: Logger
     private let graph: SourceGraph
     private let swiftVersion: SwiftVersion
 
-    required init(configuration: Configuration, logger: Logger, swiftVersion: SwiftVersion) {
+    public required init(configuration: Configuration, logger: Logger, swiftVersion: SwiftVersion) {
         self.configuration = configuration
         self.logger = logger
         self.swiftVersion = swiftVersion
         graph = SourceGraph(configuration: configuration, logger: logger)
     }
 
-    func perform(project: Project) throws -> [ScanResult] {
+    // periphery:ignore
+    public init(
+        configuration: Configuration,
+        sourceGraph: SourceGraph
+    ) {
+        self.configuration = configuration
+        logger = Logger()
+        swiftVersion = .init(shell: Shell(logger: logger))
+        graph = sourceGraph
+    }
+
+    public func perform(project: Project) throws -> [ScanResult] {
         if !configuration.indexStorePath.isEmpty {
             logger.warn("When using the '--index-store-path' option please ensure that Xcode is not running. False-positives can occur if Xcode writes to the index store while Periphery is running.")
 

Sources/SourceGraph/SourceGraph.swift

@@ -24,7 +24,7 @@ public final class SourceGraph {
     private var indexedModules: Set<String> = []
     private var unindexedExportedModules: Set<String> = []
     private var allDeclarationsByKind: [Declaration.Kind: Set<Declaration>] = [:]
-    private var allDeclarationsByUsr: [String: Declaration] = [:]
+    public private(set) var allDeclarationsByUsr: [String: Declaration] = [:]
     private var moduleToExportingModules: [String: Set<String>] = [:]
 
     private let configuration: Configuration