Merge pull request #614 from allevato/move-config

allevato · web-flow · commit b50fd28de1f2 · 2023-09-05T07:18:03.000-07:00
Move `Configuration` into the `SwiftFormat` module.
diff --git a/Documentation/Development.md b/Documentation/Development.md
@@ -4,7 +4,7 @@
 
 Since Swift does not yet have a runtime reflection system, we use code
 generation to keep the linting/formatting pipeline up-to-date. If you add or
-remove any rules from the `SwiftFormatRules` module, or if you add or remove
+remove any rules from the `SwiftFormat` module, or if you add or remove
 any `visit` methods from an existing rule in that module, you must run the
 `generate-pipeline` tool update the pipeline and configuration sources.
 
@@ -14,17 +14,9 @@ The easiest way to do this is to run the following command in your terminal:
 swift run generate-pipeline
 ```
 
-If successful, this tool will update
-`Sources/SwiftFormatConfiguration/RuleRegistry+Generated.swift` and
-`Sources/SwiftFormat/Pipelines+Generated.swift`.
-
-Likewise, you should keep the Linux XCTest manifests updated if you add or
-remove any tests from `swift-format` by running the following command in your
-terminal:
-
-```shell
-swift test --generate-linuxmain
-```
+If successful, this tool will update the files `Pipelines+Generated.swift`,
+`RuleNameCache+Generated.swift`, and `RuleRegistry+Generated.swift` in
+the `Sources/SwiftFormat/Core` directory.
 
 ## Command Line Options for Debugging
 
diff --git a/Package.swift b/Package.swift
@@ -29,6 +29,7 @@ let package = Package(
       name: "SwiftFormat",
       targets: ["SwiftFormat", "SwiftFormatConfiguration"]
     ),
+    // TODO: Remove this product after the 509 release.
     .library(
       name: "SwiftFormatConfiguration",
       targets: ["SwiftFormatConfiguration"]
@@ -49,22 +50,24 @@ let package = Package(
     .target(
       name: "SwiftFormat",
       dependencies: [
-        "SwiftFormatConfiguration",
         .product(name: "Markdown", package: "swift-markdown"),
         .product(name: "SwiftSyntax", package: "swift-syntax"),
         .product(name: "SwiftOperators", package: "swift-syntax"),
         .product(name: "SwiftParser", package: "swift-syntax"),
         .product(name: "SwiftParserDiagnostics", package: "swift-syntax"),
       ]
     ),
+    // TODO: Remove this target after the 509 release.
     .target(
-      name: "SwiftFormatConfiguration"
+      name: "SwiftFormatConfiguration",
+      dependencies: [
+        "SwiftFormat"
+      ]
     ),
     .target(
       name: "_SwiftFormatTestSupport",
       dependencies: [
         "SwiftFormat",
-        "SwiftFormatConfiguration",
         .product(name: "SwiftOperators", package: "swift-syntax"),
       ]
     ),
@@ -106,17 +109,12 @@ let package = Package(
       name: "swift-format",
       dependencies: [
         "SwiftFormat",
-        "SwiftFormatConfiguration",
         .product(name: "ArgumentParser", package: "swift-argument-parser"),
         .product(name: "SwiftSyntax", package: "swift-syntax"),
         .product(name: "SwiftParser", package: "swift-syntax"),
       ]
     ),
 
-    .testTarget(
-      name: "SwiftFormatConfigurationTests",
-      dependencies: ["SwiftFormatConfiguration"]
-    ),
     .testTarget(
       name: "SwiftFormatPerformanceTests",
       dependencies: [
@@ -130,7 +128,6 @@ let package = Package(
       name: "SwiftFormatTests",
       dependencies: [
         "SwiftFormat",
-        "SwiftFormatConfiguration",
         "_SwiftFormatTestSupport",
         .product(name: "Markdown", package: "swift-markdown"),
         .product(name: "SwiftOperators", package: "swift-syntax"),
diff --git a/Sources/SwiftFormat/API/Configuration+Default.swift b/Sources/SwiftFormat/API/Configuration+Default.swift
diff --git a/Sources/SwiftFormat/API/Configuration.swift b/Sources/SwiftFormat/API/Configuration.swift
diff --git a/Sources/SwiftFormat/API/Indent.swift b/Sources/SwiftFormat/API/Indent.swift
diff --git a/Sources/SwiftFormat/API/SwiftFormatter.swift b/Sources/SwiftFormat/API/SwiftFormatter.swift
@@ -12,7 +12,6 @@
 
 import Foundation
 import SwiftDiagnostics
-import SwiftFormatConfiguration
 import SwiftOperators
 import SwiftSyntax
 
diff --git a/Sources/SwiftFormat/API/SwiftLinter.swift b/Sources/SwiftFormat/API/SwiftLinter.swift
@@ -12,7 +12,6 @@
 
 import Foundation
 import SwiftDiagnostics
-import SwiftFormatConfiguration
 import SwiftOperators
 import SwiftSyntax
 
diff --git a/Sources/SwiftFormat/Core/Context.swift b/Sources/SwiftFormat/Core/Context.swift
@@ -11,7 +11,6 @@
 //===----------------------------------------------------------------------===//
 
 import Foundation
-import SwiftFormatConfiguration
 import SwiftOperators
 import SwiftSyntax
 import SwiftParser
diff --git a/Sources/SwiftFormat/Core/RuleRegistry+Generated.swift b/Sources/SwiftFormat/Core/RuleRegistry+Generated.swift
diff --git a/Sources/SwiftFormat/PrettyPrint/Comment.swift b/Sources/SwiftFormat/PrettyPrint/Comment.swift
@@ -11,7 +11,6 @@
 //===----------------------------------------------------------------------===//
 
 import Foundation
-import SwiftFormatConfiguration
 import SwiftSyntax
 
 extension StringProtocol {
diff --git a/Sources/SwiftFormat/PrettyPrint/Indent+Length.swift b/Sources/SwiftFormat/PrettyPrint/Indent+Length.swift
@@ -10,8 +10,6 @@
 //
 //===----------------------------------------------------------------------===//
 
-import SwiftFormatConfiguration
-
 extension Indent {
   var character: Character {
     switch self {
diff --git a/Sources/SwiftFormat/PrettyPrint/PrettyPrint.swift b/Sources/SwiftFormat/PrettyPrint/PrettyPrint.swift
@@ -10,7 +10,6 @@
 //
 //===----------------------------------------------------------------------===//
 
-import SwiftFormatConfiguration
 import SwiftSyntax
 
 /// PrettyPrinter takes a Syntax node and outputs a well-formatted, re-indented reproduction of the
diff --git a/Sources/SwiftFormat/PrettyPrint/TokenStreamCreator.swift b/Sources/SwiftFormat/PrettyPrint/TokenStreamCreator.swift
@@ -11,7 +11,6 @@
 //===----------------------------------------------------------------------===//
 
 import Foundation
-import SwiftFormatConfiguration
 import SwiftOperators
 import SwiftSyntax
 
diff --git a/Sources/SwiftFormat/PrettyPrint/Verbatim.swift b/Sources/SwiftFormat/PrettyPrint/Verbatim.swift
@@ -11,7 +11,6 @@
 //===----------------------------------------------------------------------===//
 
 import Foundation
-import SwiftFormatConfiguration
 
 /// Describes options for behavior when applying the indentation of the current context when
 /// printing a verbatim token.
diff --git a/Sources/SwiftFormat/PrettyPrint/WhitespaceLinter.swift b/Sources/SwiftFormat/PrettyPrint/WhitespaceLinter.swift
@@ -10,7 +10,6 @@
 //
 //===----------------------------------------------------------------------===//
 
-import SwiftFormatConfiguration
 import SwiftSyntax
 
 private let utf8Newline = UTF8.CodeUnit(ascii: "\n")
diff --git a/Sources/SwiftFormat/Rules/NoAssignmentInExpressions.swift b/Sources/SwiftFormat/Rules/NoAssignmentInExpressions.swift
@@ -10,7 +10,6 @@
 //
 //===----------------------------------------------------------------------===//
 
-import SwiftFormatConfiguration
 import SwiftSyntax
 
 /// Assignment expressions must be their own statements.
diff --git a/Sources/SwiftFormatConfiguration/Compatibility.swift b/Sources/SwiftFormatConfiguration/Compatibility.swift
@@ -0,0 +1,19 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2023 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+// Make these symbols that used to live in `SwiftFormatConfiguration` available when that module is
+// imported.
+// TODO: Remove this after the 509 release.
+@_exported import struct SwiftFormat.Configuration
+@_exported import struct SwiftFormat.FileScopedDeclarationPrivacyConfiguration
+@_exported import struct SwiftFormat.NoAssignmentInExpressionsConfiguration
+@_exported import enum SwiftFormat.Indent
diff --git a/Sources/_SwiftFormatTestSupport/Configuration+Testing.swift b/Sources/_SwiftFormatTestSupport/Configuration+Testing.swift
@@ -10,7 +10,7 @@
 //
 //===----------------------------------------------------------------------===//
 
-import SwiftFormatConfiguration
+import SwiftFormat
 
 extension Configuration {
   /// The default configuration to be used during unit tests.
diff --git a/Sources/_SwiftFormatTestSupport/DiagnosingTestCase.swift b/Sources/_SwiftFormatTestSupport/DiagnosingTestCase.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 import SwiftSyntax
 import XCTest
 
diff --git a/Sources/generate-pipeline/main.swift b/Sources/generate-pipeline/main.swift
@@ -24,7 +24,8 @@ let pipelineFile = sourcesDirectory
   .appendingPathComponent("Core")
   .appendingPathComponent("Pipelines+Generated.swift")
 let ruleRegistryFile = sourcesDirectory
-  .appendingPathComponent("SwiftFormatConfiguration")
+  .appendingPathComponent("SwiftFormat")
+  .appendingPathComponent("Core")
   .appendingPathComponent("RuleRegistry+Generated.swift")
 
 let ruleNameCacheFile = sourcesDirectory
diff --git a/Sources/swift-format/Frontend/ConfigurationLoader.swift b/Sources/swift-format/Frontend/ConfigurationLoader.swift
@@ -11,7 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 import Foundation
-import SwiftFormatConfiguration
+import SwiftFormat
 
 /// Loads formatter configurations, caching them in memory so that multiple operations in the same
 /// directory do not repeatedly hit the file system.
diff --git a/Sources/swift-format/Frontend/FormatFrontend.swift b/Sources/swift-format/Frontend/FormatFrontend.swift
@@ -13,7 +13,6 @@
 import Foundation
 import SwiftDiagnostics
 import SwiftFormat
-import SwiftFormatConfiguration
 import SwiftSyntax
 
 /// The frontend for formatting operations.
diff --git a/Sources/swift-format/Frontend/Frontend.swift b/Sources/swift-format/Frontend/Frontend.swift
@@ -12,7 +12,6 @@
 
 import Foundation
 import SwiftFormat
-import SwiftFormatConfiguration
 import SwiftSyntax
 import SwiftParser
 
diff --git a/Sources/swift-format/Frontend/LintFrontend.swift b/Sources/swift-format/Frontend/LintFrontend.swift
@@ -13,7 +13,6 @@
 import Foundation
 import SwiftDiagnostics
 import SwiftFormat
-import SwiftFormatConfiguration
 import SwiftSyntax
 
 /// The frontend for linting operations.
diff --git a/Sources/swift-format/Subcommands/DumpConfiguration.swift b/Sources/swift-format/Subcommands/DumpConfiguration.swift
@@ -12,7 +12,7 @@
 
 import ArgumentParser
 import Foundation
-import SwiftFormatConfiguration
+import SwiftFormat
 
 extension SwiftFormatCommand {
   /// Dumps the tool's default configuration in JSON format to standard output.
diff --git a/Tests/SwiftFormatTests/API/ConfigurationTests.swift b/Tests/SwiftFormatTests/API/ConfigurationTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 import XCTest
 
 final class ConfigurationTests: XCTestCase {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/AssignmentExprTests.swift b/Tests/SwiftFormatTests/PrettyPrint/AssignmentExprTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 
 final class AssignmentExprTests: PrettyPrintTestCase {
   func testBasicAssignmentExprs() {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/AttributeTests.swift b/Tests/SwiftFormatTests/PrettyPrint/AttributeTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 
 final class AttributeTests: PrettyPrintTestCase {
   func testAttributeParamSpacing() {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/AwaitExprTests.swift b/Tests/SwiftFormatTests/PrettyPrint/AwaitExprTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 
 final class AwaitExprTests: PrettyPrintTestCase {
   func testBasicAwaits() {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/BinaryOperatorExprTests.swift b/Tests/SwiftFormatTests/PrettyPrint/BinaryOperatorExprTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 
 final class BinaryOperatorExprTests: PrettyPrintTestCase {
   func testNonRangeFormationOperatorsAreSurroundedByBreaks() {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/ClassDeclTests.swift b/Tests/SwiftFormatTests/PrettyPrint/ClassDeclTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 
 final class ClassDeclTests: PrettyPrintTestCase {
   func testBasicClassDeclarations() {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/ClosureExprTests.swift b/Tests/SwiftFormatTests/PrettyPrint/ClosureExprTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 
 final class ClosureExprTests: PrettyPrintTestCase {
   func testBasicFunctionClosures_noPackArguments() {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/DeclNameArgumentTests.swift b/Tests/SwiftFormatTests/PrettyPrint/DeclNameArgumentTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 
 final class DeclNameArgumentTests: PrettyPrintTestCase {
   func testSelectors_noPackArguments() {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/DoStmtTests.swift b/Tests/SwiftFormatTests/PrettyPrint/DoStmtTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 
 final class DoStmtTests: PrettyPrintTestCase {
   func testBasicDoStmt() {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/EnumDeclTests.swift b/Tests/SwiftFormatTests/PrettyPrint/EnumDeclTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 
 final class EnumDeclTests: PrettyPrintTestCase {
   func testBasicEnumDeclarations() {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/ExtensionDeclTests.swift b/Tests/SwiftFormatTests/PrettyPrint/ExtensionDeclTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 
 final class ExtensionDeclTests: PrettyPrintTestCase {
   func testBasicExtensionDeclarations() {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/FunctionCallTests.swift b/Tests/SwiftFormatTests/PrettyPrint/FunctionCallTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 
 final class FunctionCallTests: PrettyPrintTestCase {
   func testBasicFunctionCalls_noPackArguments() {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/FunctionDeclTests.swift b/Tests/SwiftFormatTests/PrettyPrint/FunctionDeclTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 
 final class FunctionDeclTests: PrettyPrintTestCase {
   func testBasicFunctionDeclarations_noPackArguments() {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/IfConfigTests.swift b/Tests/SwiftFormatTests/PrettyPrint/IfConfigTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 
 final class IfConfigTests: PrettyPrintTestCase {
   func testBasicIfConfig() {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/IfStmtTests.swift b/Tests/SwiftFormatTests/PrettyPrint/IfStmtTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 import XCTest
 
 final class IfStmtTests: PrettyPrintTestCase {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/InitializerDeclTests.swift b/Tests/SwiftFormatTests/PrettyPrint/InitializerDeclTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 
 final class InitializerDeclTests: PrettyPrintTestCase {
   func testBasicInitializerDeclarations_noPackArguments() {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/MacroCallTests.swift b/Tests/SwiftFormatTests/PrettyPrint/MacroCallTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 
 final class MacroCallTests: PrettyPrintTestCase {
   func testNoWhiteSpaceAfterMacroWithoutTrailingClosure() {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/MacroDeclTests.swift b/Tests/SwiftFormatTests/PrettyPrint/MacroDeclTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 
 final class MacroDeclTests: PrettyPrintTestCase {
   func testBasicMacroDeclarations_noPackArguments() {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/MemberAccessExprTests.swift b/Tests/SwiftFormatTests/PrettyPrint/MemberAccessExprTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 
 final class MemberAccessExprTests: PrettyPrintTestCase {
   func testMemberAccess() {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/ObjectLiteralExprTests.swift b/Tests/SwiftFormatTests/PrettyPrint/ObjectLiteralExprTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 
 final class ObjectLiteralExprTests: PrettyPrintTestCase {
   func testColorLiteral_noPackArguments() {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/OperatorDeclTests.swift b/Tests/SwiftFormatTests/PrettyPrint/OperatorDeclTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 
 final class OperatorDeclTests: PrettyPrintTestCase {
   func testOperatorDecl() {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/PatternBindingTests.swift b/Tests/SwiftFormatTests/PrettyPrint/PatternBindingTests.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 
 final class PatternBindingTests: PrettyPrintTestCase {
   func testBindingIncludingTypeAnnotation() {
diff --git a/Tests/SwiftFormatTests/PrettyPrint/PrettyPrintTestCase.swift b/Tests/SwiftFormatTests/PrettyPrint/PrettyPrintTestCase.swift
@@ -1,4 +1,4 @@
-import SwiftFormatConfiguration
+import SwiftFormat
 import SwiftOperators
 import SwiftSyntax
 import SwiftParser
diff --git a/Tests/SwiftFormatTests/PrettyPrint/ProtocolDeclTests.swift b/Tests/SwiftFormatTests/PrettyPrint/ProtocolDeclTests.swift
diff --git a/Tests/SwiftFormatTests/PrettyPrint/RepeatStmtTests.swift b/Tests/SwiftFormatTests/PrettyPrint/RepeatStmtTests.swift
diff --git a/Tests/SwiftFormatTests/PrettyPrint/RespectsExistingLineBreaksTests.swift b/Tests/SwiftFormatTests/PrettyPrint/RespectsExistingLineBreaksTests.swift
diff --git a/Tests/SwiftFormatTests/PrettyPrint/StructDeclTests.swift b/Tests/SwiftFormatTests/PrettyPrint/StructDeclTests.swift
diff --git a/Tests/SwiftFormatTests/PrettyPrint/SubscriptDeclTests.swift b/Tests/SwiftFormatTests/PrettyPrint/SubscriptDeclTests.swift
diff --git a/Tests/SwiftFormatTests/PrettyPrint/SwitchCaseIndentConfigTests.swift b/Tests/SwiftFormatTests/PrettyPrint/SwitchCaseIndentConfigTests.swift
diff --git a/Tests/SwiftFormatTests/PrettyPrint/SwitchStmtTests.swift b/Tests/SwiftFormatTests/PrettyPrint/SwitchStmtTests.swift
diff --git a/Tests/SwiftFormatTests/PrettyPrint/TryCatchTests.swift b/Tests/SwiftFormatTests/PrettyPrint/TryCatchTests.swift
diff --git a/Tests/SwiftFormatTests/PrettyPrint/WhitespaceLintTests.swift b/Tests/SwiftFormatTests/PrettyPrint/WhitespaceLintTests.swift
diff --git a/Tests/SwiftFormatTests/PrettyPrint/WhitespaceTestCase.swift b/Tests/SwiftFormatTests/PrettyPrint/WhitespaceTestCase.swift
diff --git a/Tests/SwiftFormatTests/Rules/FileScopedDeclarationPrivacyTests.swift b/Tests/SwiftFormatTests/Rules/FileScopedDeclarationPrivacyTests.swift
diff --git a/Tests/SwiftFormatTests/Rules/ImportsXCTestVisitorTests.swift b/Tests/SwiftFormatTests/Rules/ImportsXCTestVisitorTests.swift
diff --git a/Tests/SwiftFormatTests/Rules/LintOrFormatRuleTestCase.swift b/Tests/SwiftFormatTests/Rules/LintOrFormatRuleTestCase.swift
