Merge branch 'main' of https://github.com/apple/swift-format into danthorpe/add_pre_commit_hooks

Author: danthorpe

.swiftci/5_10_ubuntu2204

@@ -0,0 +1,5 @@
+LinuxSwiftPackageJob {
+    swift_version_tag = "5.10-jammy"
+    repo = "swift-format"
+    branch = "main"
+}

.swiftci/5_7_ubuntu2204

@@ -0,0 +1,5 @@
+LinuxSwiftPackageJob {
+    swift_version_tag = "5.7-jammy"
+    repo = "swift-format"
+    branch = "main"
+}

.swiftci/5_8_ubuntu2204

@@ -0,0 +1,5 @@
+LinuxSwiftPackageJob {
+    swift_version_tag = "5.8-jammy"
+    repo = "swift-format"
+    branch = "main"
+}

.swiftci/5_9_ubuntu2204

@@ -0,0 +1,5 @@
+LinuxSwiftPackageJob {
+    swift_version_tag = "5.9-jammy"
+    repo = "swift-format"
+    branch = "main"
+}

.swiftci/nightly_6_0_macos

@@ -0,0 +1,5 @@
+macOSSwiftPackageJob {
+    swift_version = "6.0"
+    repo = "swift-format"
+    branch = "main"
+}

.swiftci/nightly_6_0_ubuntu2204

@@ -0,0 +1,5 @@
+LinuxSwiftPackageJob {
+    nightly_docker_tag = "nightly-6.0-jammy"
+    repo = "swift-format"
+    branch = "main"
+}

.swiftci/nightly_main_macos

@@ -0,0 +1,5 @@
+macOSSwiftPackageJob {
+    swift_version = "main"
+    repo = "swift-format"
+    branch = "main"
+}

.swiftci/nightly_main_ubuntu2204

@@ -0,0 +1,5 @@
+LinuxSwiftPackageJob {
+    nightly_docker_tag = "nightly-jammy"
+    repo = "swift-format"
+    branch = "main"
+}

.swiftci/nightly_main_windows

@@ -0,0 +1,7 @@
+WindowsSwiftPackageWithDockerImageJob {
+    docker_image = "swiftlang/swift:nightly-windowsservercore-1809"
+    repo = "swift-format"
+    branch = "main"
+    sub_dir = "swift-format"
+    label = "windows-server-2019"
+}

CMakeLists.txt

@@ -68,7 +68,7 @@ endif()
 find_package(SwiftSyntax CONFIG)
 if(NOT SwiftSyntax_FOUND)
   FetchContent_Declare(Syntax
-    GIT_REPOSITORY https://github.com/apple/swift-syntax
+    GIT_REPOSITORY https://github.com/swiftlang/swift-syntax
     GIT_TAG main)
   list(APPEND _SF_VENDOR_DEPENDENCIES Syntax)
 endif()

CODE_OF_CONDUCT.md

@@ -31,6 +31,9 @@ top-level keys and values:
     lines that are allowed to be present in a source file. Any number larger
     than this will be collapsed down to the maximum.
 
+*   `spacesBeforeEndOfLineComments` _(number)_: The number of spaces between 
+    the last token on a non-empty line and a line comment starting with `//`.
+
 *   `respectsExistingLineBreaks` _(boolean)_: Indicates whether or not existing
     line breaks in the source code should be honored (if they are valid
     according to the style guidelines being enforced). If this settings is
@@ -58,6 +61,13 @@ top-level keys and values:
     (the default), requirements will be laid out horizontally first, with line breaks 
     only being fired when the line length would be exceeded.
 
+*   `lineBreakBetweenDeclarationAttributes` _(boolean)_:  Determines the 
+    line-breaking behavior for adjacent attributes on declarations.
+    If true, a line break will be added between each attribute, forcing the
+    attribute list to be laid out vertically. If false (the default),
+    attributes will be laid out horizontally first, with line breaks only
+    being fired when the line length would be exceeded.
+
 *   `prioritizeKeepingFunctionOutputTogether` _(boolean)_: Determines if 
     function-like declaration outputs should be prioritized to be together with the
     function signature right (closing) parenthesis. If false (the default), function 

CONTRIBUTING.md

@@ -263,7 +263,7 @@ if someCondition {
 ### Token Generation
 
 Token generation begins with the abstract syntax tree (AST) of the Swift source
-file, provided by the [SwiftSyntax](https://github.com/apple/swift-syntax)
+file, provided by the [SwiftSyntax](https://github.com/swiftlang/swift-syntax)
 library. We have overloaded a `visit` method for each of the different kinds of
 syntax nodes. Most of these nodes are higher-level, and are composed of other
 nodes. For example, `FunctionDeclSyntax` contains

Documentation/Configuration.md

@@ -4,7 +4,7 @@
 
 Use the rules below in the `rules` block of your `.swift-format`
 configuration file, as described in
-[Configuration](Documentation/Configuration.md). All of these rules can be
+[Configuration](Configuration.md). All of these rules can be
 applied in the linter, but only some of them can format your source code
 automatically.
 
@@ -14,6 +14,7 @@ Here's the list of available rules:
 - [AlwaysUseLiteralForEmptyCollectionInit](#AlwaysUseLiteralForEmptyCollectionInit)
 - [AlwaysUseLowerCamelCase](#AlwaysUseLowerCamelCase)
 - [AmbiguousTrailingClosureOverload](#AmbiguousTrailingClosureOverload)
+- [AvoidRetroactiveConformances](#AvoidRetroactiveConformances)
 - [BeginDocumentationCommentWithOneLineSummary](#BeginDocumentationCommentWithOneLineSummary)
 - [DoNotUseSemicolons](#DoNotUseSemicolons)
 - [DontRepeatTypeInStaticProperties](#DontRepeatTypeInStaticProperties)
@@ -28,6 +29,7 @@ Here's the list of available rules:
 - [NoAssignmentInExpressions](#NoAssignmentInExpressions)
 - [NoBlockComments](#NoBlockComments)
 - [NoCasesWithOnlyFallthrough](#NoCasesWithOnlyFallthrough)
+- [NoEmptyLinesOpeningClosingBraces](#NoEmptyLinesOpeningClosingBraces)
 - [NoEmptyTrailingClosureParentheses](#NoEmptyTrailingClosureParentheses)
 - [NoLabelsInCasePatterns](#NoLabelsInCasePatterns)
 - [NoLeadingUnderscores](#NoLeadingUnderscores)
@@ -78,6 +80,7 @@ Underscores (except at the beginning of an identifier) are disallowed.
 
 This rule does not apply to test code, defined as code which:
   * Contains the line `import XCTest`
+  * The function is marked with `@Test` attribute
 
 Lint: If an identifier contains underscores or begins with a capital letter, a lint error is
       raised.
@@ -93,6 +96,14 @@ Lint: If two overloaded functions with one closure parameter appear in the same
 
 `AmbiguousTrailingClosureOverload` is a linter-only rule.
 
+### AvoidRetroactiveConformances
+
+`@retroactive` conformances are forbidden.
+
+Lint: Using `@retroactive` results in a lint error.
+
+`AvoidRetroactiveConformances` is a linter-only rule.
+
 ### BeginDocumentationCommentWithOneLineSummary
 
 All documentation comments must begin with a one-line summary of the declaration.
@@ -179,6 +190,7 @@ Force-unwraps are strongly discouraged and must be documented.
 
 This rule does not apply to test code, defined as code which:
   * Contains the line `import XCTest`
+  * The function is marked with `@Test` attribute
 
 Lint: If a force unwrap is used, a lint warning is raised.
 
@@ -190,6 +202,7 @@ Force-try (`try!`) is forbidden.
 
 This rule does not apply to test code, defined as code which:
   * Contains the line `import XCTest`
+  * The function is marked with `@Test` attribute
 
 Lint: Using `try!` results in a lint error.
 
@@ -205,6 +218,7 @@ Certain properties (e.g. `@IBOutlet`) tied to the UI lifecycle are ignored.
 
 This rule does not apply to test code, defined as code which:
   * Contains the line `import XCTest`
+  * The function is marked with `@Test` attribute
 
 TODO: Create exceptions for other UI elements (ex: viewDidLoad)
 
@@ -258,6 +272,16 @@ Format: The fallthrough `case` is added as a prefix to the next case unless the
 
 `NoCasesWithOnlyFallthrough` rule can format your code automatically.
 
+### NoEmptyLinesOpeningClosingBraces
+
+Empty lines are forbidden after opening braces and before closing braces.
+
+Lint: Empty lines after opening braces and before closing braces yield a lint error.
+
+Format: Empty lines after opening braces and before closing braces will be removed.
+
+`NoEmptyLinesOpeningClosingBraces` rule can format your code automatically.
+
 ### NoEmptyTrailingClosureParentheses
 
 Function calls with no arguments and a trailing closure should not have empty parentheses.

Documentation/PrettyPrinter.md

@@ -41,7 +41,8 @@ let package = Package(
   dependencies: dependencies,
   targets: [
     .target(
-      name: "_SwiftFormatInstructionCounter"
+      name: "_SwiftFormatInstructionCounter",
+      exclude: ["CMakeLists.txt"]
     ),
 
     .target(
@@ -53,7 +54,8 @@ let package = Package(
         .product(name: "SwiftOperators", package: "swift-syntax"),
         .product(name: "SwiftParser", package: "swift-syntax"),
         .product(name: "SwiftParserDiagnostics", package: "swift-syntax"),
-      ]
+      ],
+      exclude: ["CMakeLists.txt"]
     ),
     .target(
       name: "_SwiftFormatTestSupport",
@@ -105,6 +107,7 @@ let package = Package(
         .product(name: "SwiftSyntax", package: "swift-syntax"),
         .product(name: "SwiftParser", package: "swift-syntax"),
       ],
+      exclude: ["CMakeLists.txt"],
       linkerSettings: swiftformatLinkSettings
     ),
 
@@ -163,7 +166,7 @@ var dependencies: [Package.Dependency] {
     return [
       .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.2.2"),
       .package(url: "https://github.com/apple/swift-markdown.git", from: "0.2.0"),
-      .package(url: "https://github.com/apple/swift-syntax.git", branch: "main"),
+      .package(url: "https://github.com/swiftlang/swift-syntax.git", branch: "main"),
     ]
   }
 }

Documentation/RuleDocumentation.md

@@ -1,7 +1,7 @@
 # swift-format
 
 `swift-format` provides the formatting technology for
-[SourceKit-LSP](https://github.com/apple/sourcekit-lsp) and the building
+[SourceKit-LSP](https://github.com/swiftlang/sourcekit-lsp) and the building
 blocks for doing code formatting transformations.
 
 This package can be used as a [command line tool](#command-line-usage)
@@ -18,7 +18,7 @@ invoked via an [API](#api-usage).
 ### Swift 5.8 and later
 
 As of Swift 5.8, swift-format depends on the version of
-[SwiftSyntax](https://github.com/apple/swift-syntax) whose parser has been
+[SwiftSyntax](https://github.com/swiftlang/swift-syntax) whose parser has been
 rewritten in Swift and no longer has dependencies on libraries in the
 Swift toolchain.
 
@@ -34,7 +34,7 @@ SwiftSyntax; the 5.8 release of swift-format is `508.0.0`, not `0.50800.0`.
 ### Swift 5.7 and earlier
 
 `swift-format` versions 0.50700.0 and earlier depend on versions of
-[SwiftSyntax](https://github.com/apple/swift-syntax) that used a standalone
+[SwiftSyntax](https://github.com/swiftlang/swift-syntax) that used a standalone
 parsing library distributed as part of the Swift toolchain. When using these
 versions, you should check out and build `swift-format` from the release
 tag or branch that is compatible with the version of Swift you are using.
@@ -61,8 +61,11 @@ For example, if you are using Xcode 13.3 (Swift 5.6), you will need
 ## Getting swift-format
 
 If you are mainly interested in using swift-format (rather than developing it),
-then you can get swift-format either via [Homebrew](https://brew.sh/) or by checking out the
-source and building it.
+then you can get it in three different ways:
+
+### Included in Xcode
+
+Xcode 16 and above include swift-format in the toolchain. You can run `swift-format` from anywhere on the system using `swift format` (notice the space instead of dash). To find the path at which `swift-format` is installed, run `xcrun --find swift-format`.
 
 ### Installing via Homebrew
 
@@ -74,7 +77,7 @@ Install `swift-format` using the following commands:
 
 ```sh
 VERSION=510.1.0  # replace this with the version you need
-git clone https://github.com/apple/swift-format.git
+git clone https://github.com/swiftlang/swift-format.git
 cd swift-format
 git checkout "tags/$VERSION"
 swift build -c release
@@ -251,3 +254,24 @@ been merged into `main`.
 
 If you are interested in developing `swift-format`, there is additional
 documentation about that [here](Documentation/Development.md).
+
+## Contributing
+
+Contributions to Swift are welcomed and encouraged! Please see the
+[Contributing to Swift guide](https://swift.org/contributing/).
+
+Before submitting the pull request, please make sure you have [tested your
+ changes](https://github.com/apple/swift/blob/main/docs/ContinuousIntegration.md)
+ and that they follow the Swift project [guidelines for contributing
+ code](https://swift.org/contributing/#contributing-code).
+
+To be a truly great community, [Swift.org](https://swift.org/) needs to welcome
+developers from all walks of life, with different backgrounds, and with a wide
+range of experience. A diverse and friendly community will have more great
+ideas, more unique perspectives, and produce more great code. We will work
+diligently to make the Swift community welcoming to everyone.
+
+To give clarity of what is expected of our members, Swift has adopted the
+code of conduct defined by the Contributor Covenant. This document is used
+across many open source communities, and we think it articulates our values
+well. For more, see the [Code of Conduct](https://swift.org/code-of-conduct/).

Package.swift

@@ -26,10 +26,12 @@ extension Configuration {
     self.lineLength = 100
     self.tabWidth = 8
     self.indentation = .spaces(2)
+    self.spacesBeforeEndOfLineComments = 2
     self.respectsExistingLineBreaks = true
     self.lineBreakBeforeControlFlowKeywords = false
     self.lineBreakBeforeEachArgument = false
     self.lineBreakBeforeEachGenericRequirement = false
+    self.lineBreakBetweenDeclarationAttributes = false
     self.prioritizeKeepingFunctionOutputTogether = false
     self.indentConditionalCompilationBlocks = true
     self.lineBreakAroundMultilineExpressionChainComponents = false
@@ -38,5 +40,6 @@ extension Configuration {
     self.spacesAroundRangeFormationOperators = false
     self.noAssignmentInExpressions = NoAssignmentInExpressionsConfiguration()
     self.multiElementCollectionTrailingCommas = true
+    self.reflowMultilineStringLiterals = .never
   }
 }