Extract Configuration into new target (#817)

.github/workflows/test.yml

@@ -18,7 +18,7 @@ jobs:
     steps:
       - uses: actions/checkout@master
       - uses: jdx/mise-action@v2
-      - run: mise run lint
+      - run: mise run lint-ci
   macOS:
     strategy:
       fail-fast: false

.mise/tasks/lint

@@ -4,5 +4,5 @@ set -euo pipefail
 
 cd $MISE_PROJECT_ROOT
 
-swiftformat --quiet --strict .
-swiftlint lint --quiet --strict
+swiftformat .
+swiftlint lint --quiet

.mise/tasks/lint-ci

@@ -0,0 +1,8 @@
+#!/bin/bash
+# mise description="Lint the project for CI"
+set -euo pipefail
+
+cd $MISE_PROJECT_ROOT
+
+swiftformat --quiet --strict .
+swiftlint lint --quiet --strict

Package.swift

@@ -35,13 +35,33 @@ var targets: [PackageDescription.Target] = [
         name: "Frontend",
         dependencies: [
             .target(name: "Shared"),
+            .target(name: "Configuration"),
             .target(name: "SourceGraph"),
             .target(name: "PeripheryKit"),
             .target(name: "ProjectDrivers"),
             .product(name: "ArgumentParser", package: "swift-argument-parser"),
             .product(name: "FilenameMatcher", package: "swift-filename-matcher"),
         ]
     ),
+    .target(
+        name: "Configuration",
+        dependencies: [
+            .target(name: "Extensions"),
+            .target(name: "Shared"),
+            .target(name: "Logger"),
+            .product(name: "Yams", package: "Yams"),
+            .product(name: "SystemPackage", package: "swift-system"),
+            .product(name: "FilenameMatcher", package: "swift-filename-matcher"),
+        ]
+    ),
+    .target(
+        name: "Extensions",
+        dependencies: [
+            .product(name: "SystemPackage", package: "swift-system"),
+            .product(name: "FilenameMatcher", package: "swift-filename-matcher"),
+        ]
+    ),
+    .target(name: "Logger"),
     .target(
         name: "PeripheryKit",
         dependencies: [
@@ -80,14 +100,16 @@ var targets: [PackageDescription.Target] = [
     .target(
         name: "SourceGraph",
         dependencies: [
+            .target(name: "Configuration"),
             .product(name: "SwiftSyntax", package: "swift-syntax"),
             .target(name: "Shared"),
         ]
     ),
     .target(
         name: "Shared",
         dependencies: [
-            .product(name: "Yams", package: "Yams"),
+            .target(name: "Extensions"),
+            .target(name: "Logger"),
             .product(name: "SystemPackage", package: "swift-system"),
             .product(name: "FilenameMatcher", package: "swift-filename-matcher"),
         ]
@@ -120,6 +142,7 @@ var targets: [PackageDescription.Target] = [
         dependencies: [
             .target(name: "TestShared"),
             .target(name: "PeripheryKit"),
+            .target(name: "Configuration"),
         ],
         exclude: ["AccessibilityProject"]
     ),

Sources/Shared/Configuration.swift → Sources/Configuration/Configuration.swift

@@ -1,5 +1,8 @@
+import Extensions
 import FilenameMatcher
 import Foundation
+import Logger
+import Shared
 import SystemPackage
 import Yams
 
@@ -38,7 +41,7 @@ public final class Configuration {
     @Setting(key: "xcode_list_arguments", defaultValue: [])
     public var xcodeListArguments: [String]
 
-    @Setting(key: "retain_assign_only_property_types", defaultValue: [], setter: PropertyTypeSanitizer.sanitize)
+    @Setting(key: "retain_assign_only_property_types", defaultValue: [])
     public var retainAssignOnlyPropertyTypes: [String]
 
     @Setting(key: "external_encodable_protocols", defaultValue: [])

Sources/Shared/Extensions/FilePath+Glob.swift → Sources/Extensions/FilePath+Glob.swift

@@ -69,7 +69,7 @@ private class Glob {
         let firstPart = parts.removeFirst()
         var lastPart = parts.joined(separator: "**")
 
-        var directories: [URL] = if FileManager.default.fileExists(atPath: firstPart) {
+        let directories: [URL] = if FileManager.default.fileExists(atPath: firstPart) {
             exploreDirectories(url: URL(fileURLWithPath: firstPart))
         } else {
             []

Sources/Frontend/Commands/CheckUpdateCommand.swift

@@ -1,6 +1,7 @@
 import ArgumentParser
+import Configuration
 import Foundation
-import Shared
+import Logger
 
 struct CheckUpdateCommand: FrontendCommand {
     static let configuration = CommandConfiguration(

Sources/Frontend/Commands/ClearCacheCommand.swift

@@ -1,5 +1,7 @@
 import ArgumentParser
+import Configuration
 import Foundation
+import Logger
 import Shared
 
 struct ClearCacheCommand: FrontendCommand {

Sources/Frontend/Commands/FrontendCommand.swift

@@ -1,5 +1,5 @@
 import ArgumentParser
-import Shared
+import Logger
 
 protocol FrontendCommand: ParsableCommand {}
 extension FrontendCommand {

Sources/Frontend/Commands/ScanCommand.swift

@@ -1,5 +1,8 @@
 import ArgumentParser
+import Configuration
 import Foundation
+import Logger
+import PeripheryKit
 import Shared
 import SystemPackage
 
@@ -135,14 +138,13 @@ struct ScanCommand: FrontendCommand {
     private static let defaultConfiguration = Configuration()
 
     func run() throws {
+        let logger = Logger(quiet: quiet, verbose: verbose)
+        logger.contextualized(with: "version").debug(PeripheryVersion)
+
         let configuration = Configuration()
-        let logger = Logger(configuration: configuration)
-        let shell = Shell(logger: logger)
-        let swiftVersion = SwiftVersion(shell: shell)
-        let scanBehavior = ScanBehavior(configuration: configuration, logger: logger, shell: shell, swiftVersion: swiftVersion)
 
         if !setup {
-            try scanBehavior.setup(config).get()
+            try configuration.load(from: config, logger: logger)
         }
 
         configuration.guidedSetup = setup
@@ -186,13 +188,59 @@ struct ScanCommand: FrontendCommand {
         configuration.apply(\.$bazel, bazel)
         configuration.apply(\.$bazelFilter, bazelFilter)
 
-        try scanBehavior.main { project in
-            try Scan(
-                configuration: configuration,
-                logger: logger,
-                swiftVersion: swiftVersion
-            ).perform(project: project)
-        }.get()
+        let shell = Shell(logger: logger)
+        let swiftVersion = SwiftVersion(shell: shell)
+        logger.debug(swiftVersion.fullVersion)
+        try swiftVersion.validateVersion()
+
+        let project: Project = if configuration.guidedSetup {
+            try GuidedSetup(configuration: configuration, shell: shell, logger: logger).perform()
+        } else {
+            try Project(configuration: configuration, shell: shell, logger: logger)
+        }
+
+        let updateChecker = UpdateChecker(logger: logger, configuration: configuration)
+        updateChecker.run()
+
+        let results = try Scan(
+            configuration: configuration,
+            logger: logger,
+            swiftVersion: swiftVersion
+        ).perform(project: project)
+
+        let interval = logger.beginInterval("result:output")
+        var baseline: Baseline?
+
+        if let baselinePath = configuration.baseline {
+            let data = try Data(contentsOf: baselinePath.url)
+            baseline = try JSONDecoder().decode(Baseline.self, from: data)
+        }
+
+        let filteredResults = try OutputDeclarationFilter(configuration: configuration, logger: logger).filter(results, with: baseline)
+
+        if let baselinePath = configuration.writeBaseline {
+            let usrs = filteredResults
+                .flatMapSet { $0.usrs }
+                .union(baseline?.usrs ?? [])
+            let baseline = Baseline.v1(usrs: usrs.sorted())
+            let data = try JSONEncoder().encode(baseline)
+            try data.write(to: baselinePath.url)
+        }
+
+        let output = try configuration.outputFormat.formatter.init(configuration: configuration).format(filteredResults)
+
+        if configuration.outputFormat.supportsAuxiliaryOutput {
+            logger.info("", canQuiet: true)
+        }
+
+        logger.info(output, canQuiet: false)
+        logger.endInterval(interval)
+
+        updateChecker.notifyIfAvailable()
+
+        if !filteredResults.isEmpty, configuration.strict {
+            throw PeripheryError.foundIssues(count: filteredResults.count)
+        }
     }
 }
 

Sources/Frontend/CommonSetupGuide.swift

@@ -1,4 +1,6 @@
+import Configuration
 import Foundation
+import Logger
 import Shared
 
 final class CommonSetupGuide: SetupGuideHelpers {

Sources/Frontend/GuidedSetup.swift

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

Sources/Frontend/Logger+Extension.swift

@@ -0,0 +1,9 @@
+import Configuration
+import Logger
+
+public extension Logger {
+    @inlinable
+    convenience init(configuration: Configuration) {
+        self.init(quiet: configuration.quiet, verbose: configuration.verbose)
+    }
+}

Sources/Frontend/Project.swift

@@ -1,4 +1,6 @@
+import Configuration
 import Foundation
+import Logger
 import ProjectDrivers
 import Shared
 import SystemPackage

Sources/Frontend/SPMProjectSetupGuide.swift

@@ -1,4 +1,5 @@
 import Foundation
+import ProjectDrivers
 import Shared
 import SystemPackage
 

Sources/Frontend/Scan.swift

@@ -1,5 +1,7 @@
+import Configuration
 import Foundation
 import Indexer
+import Logger
 import PeripheryKit
 import ProjectDrivers
 import Shared

Sources/Frontend/UpdateChecker.swift

@@ -1,4 +1,6 @@
+import Configuration
 import Foundation
+import Logger
 import Shared
 
 #if canImport(FoundationNetworking)