Merge pull request #593 from allevato/fewer-modules

Collapse almost everything into a single `SwiftFormat` module.

Author: allevato

Package.swift

@@ -50,10 +50,7 @@ let package = Package(
       name: "SwiftFormat",
       dependencies: [
         "SwiftFormatConfiguration",
-        "SwiftFormatCore",
-        "SwiftFormatPrettyPrint",
-        "SwiftFormatRules",
-        "SwiftFormatWhitespaceLinter",
+        .product(name: "Markdown", package: "swift-markdown"),
         .product(name: "SwiftSyntax", package: "swift-syntax"),
         .product(name: "SwiftOperators", package: "swift-syntax"),
         .product(name: "SwiftParser", package: "swift-syntax"),
@@ -64,46 +61,13 @@ let package = Package(
       name: "SwiftFormatConfiguration"
     ),
     .target(
-      name: "SwiftFormatCore",
-      dependencies: [
-        "SwiftFormatConfiguration",
-        .product(name: "Markdown", package: "swift-markdown"),
-        .product(name: "SwiftOperators", package: "swift-syntax"),
-        .product(name: "SwiftSyntax", package: "swift-syntax"),
-      ]
-    ),
-    .target(
-      name: "SwiftFormatRules",
-      dependencies: [
-        "SwiftFormatCore",
-        "SwiftFormatConfiguration",
-        .product(name: "Markdown", package: "swift-markdown"),
-      ]
-    ),
-    .target(
-      name: "SwiftFormatPrettyPrint",
-      dependencies: [
-        "SwiftFormatCore",
-        "SwiftFormatConfiguration",
-        .product(name: "SwiftOperators", package: "swift-syntax"),
-      ]
-    ),
-    .target(
-      name: "SwiftFormatTestSupport",
+      name: "_SwiftFormatTestSupport",
       dependencies: [
-        "SwiftFormatCore",
-        "SwiftFormatRules",
+        "SwiftFormat",
         "SwiftFormatConfiguration",
         .product(name: "SwiftOperators", package: "swift-syntax"),
       ]
     ),
-    .target(
-      name: "SwiftFormatWhitespaceLinter",
-      dependencies: [
-        "SwiftFormatCore",
-        .product(name: "SwiftSyntax", package: "swift-syntax"),
-      ]
-    ),
     .plugin(
       name: "Format Source Code",
       capability: .command(
@@ -133,8 +97,7 @@ let package = Package(
     .executableTarget(
       name: "generate-pipeline",
       dependencies: [
-        "SwiftFormatCore",
-        "SwiftFormatRules",
+        "SwiftFormat",
         .product(name: "SwiftSyntax", package: "swift-syntax"),
         .product(name: "SwiftParser", package: "swift-syntax"),
       ]
@@ -144,7 +107,6 @@ let package = Package(
       dependencies: [
         "SwiftFormat",
         "SwiftFormatConfiguration",
-        "SwiftFormatCore",
         .product(name: "ArgumentParser", package: "swift-argument-parser"),
         .product(name: "SwiftSyntax", package: "swift-syntax"),
         .product(name: "SwiftParser", package: "swift-syntax"),
@@ -155,60 +117,26 @@ let package = Package(
       name: "SwiftFormatConfigurationTests",
       dependencies: ["SwiftFormatConfiguration"]
     ),
-    .testTarget(
-      name: "SwiftFormatCoreTests",
-      dependencies: [
-        "SwiftFormatConfiguration",
-        "SwiftFormatCore",
-        .product(name: "Markdown", package: "swift-markdown"),
-        .product(name: "SwiftSyntax", package: "swift-syntax"),
-        .product(name: "SwiftSyntaxBuilder", package: "swift-syntax"),
-        .product(name: "SwiftParser", package: "swift-syntax"),
-      ]
-    ),
     .testTarget(
       name: "SwiftFormatPerformanceTests",
       dependencies: [
-        "SwiftFormatTestSupport",
-        "SwiftFormatWhitespaceLinter",
+        "SwiftFormat",
+        "_SwiftFormatTestSupport",
         .product(name: "SwiftSyntax", package: "swift-syntax"),
         .product(name: "SwiftParser", package: "swift-syntax"),
       ]
     ),
     .testTarget(
-      name: "SwiftFormatPrettyPrintTests",
+      name: "SwiftFormatTests",
       dependencies: [
+        "SwiftFormat",
         "SwiftFormatConfiguration",
-        "SwiftFormatCore",
-        "SwiftFormatPrettyPrint",
-        "SwiftFormatRules",
-        "SwiftFormatTestSupport",
-        .product(name: "SwiftSyntax", package: "swift-syntax"),
+        "_SwiftFormatTestSupport",
+        .product(name: "Markdown", package: "swift-markdown"),
         .product(name: "SwiftOperators", package: "swift-syntax"),
         .product(name: "SwiftParser", package: "swift-syntax"),
-      ]
-    ),
-    .testTarget(
-      name: "SwiftFormatRulesTests",
-      dependencies: [
-        "SwiftFormatConfiguration",
-        "SwiftFormatCore",
-        "SwiftFormatPrettyPrint",
-        "SwiftFormatRules",
-        "SwiftFormatTestSupport",
         .product(name: "SwiftSyntax", package: "swift-syntax"),
-        .product(name: "SwiftParser", package: "swift-syntax"),
-      ]
-    ),
-    .testTarget(
-      name: "SwiftFormatWhitespaceLinterTests",
-      dependencies: [
-        "SwiftFormatConfiguration",
-        "SwiftFormatCore",
-        "SwiftFormatTestSupport",
-        "SwiftFormatWhitespaceLinter",
-        .product(name: "SwiftSyntax", package: "swift-syntax"),
-        .product(name: "SwiftParser", package: "swift-syntax"),
+        .product(name: "SwiftSyntaxBuilder", package: "swift-syntax"),
       ]
     ),
   ]

Sources/SwiftFormat/DebugOptions.swift renamed to Sources/SwiftFormat/API/DebugOptions.swift

@@ -13,9 +13,6 @@
 import Foundation
 import SwiftDiagnostics
 import SwiftFormatConfiguration
-import SwiftFormatCore
-import SwiftFormatPrettyPrint
-import SwiftFormatRules
 import SwiftOperators
 import SwiftSyntax
 

Sources/SwiftFormatCore/Finding.swift renamed to Sources/SwiftFormat/API/Finding.swift

@@ -13,10 +13,6 @@
 import Foundation
 import SwiftDiagnostics
 import SwiftFormatConfiguration
-import SwiftFormatCore
-import SwiftFormatPrettyPrint
-import SwiftFormatRules
-import SwiftFormatWhitespaceLinter
 import SwiftOperators
 import SwiftSyntax
 

Sources/SwiftFormatCore/FindingCategorizing.swift renamed to Sources/SwiftFormat/API/FindingCategorizing.swift

@@ -10,7 +10,6 @@
 //
 //===----------------------------------------------------------------------===//
 
-import SwiftFormatCore
 import SwiftSyntax
 
 fileprivate final class AddModifierRewriter: SyntaxRewriter {

Sources/SwiftFormat/SwiftFormatError.swift renamed to Sources/SwiftFormat/API/SwiftFormatError.swift

@@ -20,6 +20,7 @@ import SwiftParser
 ///
 /// Specifically, it is the container for the shared configuration, diagnostic consumer, and URL of
 /// the current file.
+@_spi(Rules)
 public final class Context {
 
   /// Tracks whether `XCTest` has been imported so that certain logic can be modified for files that
@@ -37,28 +38,28 @@ public final class Context {
   }
 
   /// The configuration for this run of the pipeline, provided by a configuration JSON file.
-  public let configuration: Configuration
+  let configuration: Configuration
 
   /// Defines the operators and their precedence relationships that were used during parsing.
-  public let operatorTable: OperatorTable
+  let operatorTable: OperatorTable
 
   /// Emits findings to the finding consumer.
-  public let findingEmitter: FindingEmitter
+  let findingEmitter: FindingEmitter
 
   /// The URL of the file being linted or formatted.
-  public let fileURL: URL
+  let fileURL: URL
 
   /// Indicates whether the file is known to import XCTest.
   public var importsXCTest: XCTestImportState
 
   /// An object that converts `AbsolutePosition` values to `SourceLocation` values.
-  public let sourceLocationConverter: SourceLocationConverter
+  let sourceLocationConverter: SourceLocationConverter
 
   /// Contains the rules have been disabled by comments for certain line numbers.
-  public let ruleMask: RuleMask
+  let ruleMask: RuleMask
 
   /// Contains all the available rules' names associated to their types' object identifiers.
-  public let ruleNameCache: [ObjectIdentifier: String]
+  let ruleNameCache: [ObjectIdentifier: String]
 
   /// Creates a new Context with the provided configuration, diagnostic engine, and file URL.
   public init(
@@ -87,7 +88,7 @@ public final class Context {
 
   /// Given a rule's name and the node it is examining, determine if the rule is disabled at this
   /// location or not.
-  public func isRuleEnabled<R: Rule>(_ rule: R.Type, node: Syntax) -> Bool {
+  func isRuleEnabled<R: Rule>(_ rule: R.Type, node: Syntax) -> Bool {
     let loc = node.startLocation(converter: self.sourceLocationConverter)
 
     assert(

Sources/SwiftFormat/SwiftFormatter.swift renamed to Sources/SwiftFormat/API/SwiftFormatter.swift

@@ -19,6 +19,7 @@ import SwiftSyntax
 /// also the nested information that can be provided on a parameter. For example, when a parameter
 /// is a function type, it can provide not only a brief summary but also its own parameter and
 /// return value descriptions.
+@_spi(Testing)
 public struct DocumentationComment {
   /// A description of a parameter in a documentation comment.
   public struct Parameter {