Merge branch 'main' into bound-case-formatter

Author: natecook1000

.pre-commit-hooks.yaml

@@ -4,3 +4,9 @@
   language: swift
   types: [swift]
   require_serial: true
+- id: swift-format-lint
+  name: swift-format-lint
+  entry: swift-format lint --strict --recursive --parallel
+  language: swift
+  types: [swift]
+  require_serial: true

Documentation/Configuration.md

@@ -113,7 +113,7 @@ top-level keys and values:
 ### `prioritizeKeepingFunctionOutputTogether`  
 **type:** boolean  
 
-**description:** Determines if function-like declaration outputs should be prioritized to be together with thefunction signature right (closing) parenthesis. If `false`, function output (i.e. throws, return type) is not prioritized to be together with the signature's right parenthesis, and when the line length would be exceeded,a line break will be fired after the function signature first, indenting the declaration output one additional level. If true, A line break will be fired further up in the function's declaration (e.g. generic parameters, parameters) before breaking on the function's output.  
+**description:** Determines if function-like declaration outputs should be prioritized to be together with the function signature's right (closing) parenthesis. If `false`, function output (i.e. throws, return type) is not prioritized to be together with the signature's right parenthesis, and when the line length would be exceeded, a line break will be fired after the function signature first, indenting the declaration output one additional level. If true, a line break will be fired further up in the function's declaration (e.g. generic parameters, parameters) before breaking on the function's output.  
 
 **default:** `false`  
 
@@ -186,7 +186,7 @@ switch someValue {
 ### `noAssignmentInExpressions`
 **type:** object
 
-**description:** Assignment expressions must be their own statements. Assignment should not be used in an expression context that expects a `Void` value. For example, assigning a variable within a `return` statement existing a `Void` function is prohibited.
+**description:** Assignment expressions must be their own statements. Assignment should not be used in an expression context that expects a `Void` value. For example, assigning a variable within a `return` statement exiting a `Void` function is prohibited.
 
 - `allowedFunctions` _(strings array)_: A list of function names where assignments are allowed to be embedded in expressions that are passed as parameters to that function.
 
@@ -221,7 +221,7 @@ a hard line break
 will be formatted as:
 ```swift
 """
-an esacpe\
+an escape\
  line break
 a hard \
 line break

Documentation/RuleDocumentation.md

@@ -243,7 +243,7 @@ Format: The access level is removed from the extension declaration and is added
 Assignment expressions must be their own statements.
 
 Assignment should not be used in an expression context that expects a `Void` value. For example,
-assigning a variable within a `return` statement existing a `Void` function is prohibited.
+assigning a variable within a `return` statement exiting a `Void` function is prohibited.
 
 Lint: If an assignment expression is found in a position other than a standalone statement, a
       lint finding is emitted.

README.md

@@ -210,13 +210,19 @@ settings in the default configuration can be viewed by running
 `swift-format dump-configuration`, which will dump it to standard
 output.
 
-If the `--configuration <file>` option is passed to `swift-format`, then that
-configuration will be used unconditionally and the file system will not be
-searched.
+If the `--configuration <configuration>` option is passed to `swift-format`,
+then that configuration will be used unconditionally and the file system will
+not be searched.
 
 See [Documentation/Configuration.md](Documentation/Configuration.md) for a
-description of the configuration file format and the settings that are
-available.
+description of the configuration format and the settings that are available.
+
+#### Viewing the Effective Configuration
+
+The `dump-configuration` subcommand accepts a `--effective` flag. If set, it
+dumps the configuration that would be used if `swift-format` was executed from
+the current working directory, and accounts for `.swift-format` files or
+ `--configuration` options as outlined above.
 
 ### Miscellaneous
 

Sources/SwiftFormat/API/Configuration+Dump.swift

@@ -0,0 +1,35 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2025 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
+//
+//===----------------------------------------------------------------------===//
+
+import Foundation
+
+extension Configuration {
+  /// Return the configuration as a JSON string.
+  public func asJsonString() throws -> String {
+    let data: Data
+
+    do {
+      let encoder = JSONEncoder()
+      encoder.outputFormatting = [.prettyPrinted, .sortedKeys]
+      data = try encoder.encode(self)
+    } catch {
+      throw SwiftFormatError.configurationDumpFailed("\(error)")
+    }
+
+    guard let jsonString = String(data: data, encoding: .utf8) else {
+      // This should never happen, but let's make sure we fail more gracefully than crashing, just in case.
+      throw SwiftFormatError.configurationDumpFailed("The JSON was not valid UTF-8")
+    }
+
+    return jsonString
+  }
+}

Sources/SwiftFormat/API/Configuration.swift

@@ -122,12 +122,12 @@ public struct Configuration: Codable, Equatable {
   public var lineBreakBetweenDeclarationAttributes: Bool
 
   /// Determines if function-like declaration outputs should be prioritized to be together with the
-  /// function signature right (closing) parenthesis.
+  /// function signature's right (closing) parenthesis.
   ///
   /// If false (the default), function output (i.e. throws, return type) is not prioritized to be
   /// together with the signature's right parenthesis, and when the line length would be exceeded,
   /// a line break will be fired after the function signature first, indenting the declaration output
-  /// one additional level. If true, A line break will be fired further up in the function's
+  /// one additional level. If true, a line break will be fired further up in the function's
   /// declaration (e.g. generic parameters, parameters) before breaking on the function's output.
   public var prioritizeKeepingFunctionOutputTogether: Bool
 
@@ -211,7 +211,7 @@ public struct Configuration: Codable, Equatable {
     /// will be formatted as:
     /// ```swift
     /// """
-    /// an esacpe\
+    /// an escape\
     ///  line break
     /// a hard \
     /// line break
@@ -285,11 +285,9 @@ public struct Configuration: Codable, Equatable {
     // If the version number is not present, assume it is 1.
     self.version = try container.decodeIfPresent(Int.self, forKey: .version) ?? 1
     guard version <= highestSupportedConfigurationVersion else {
-      throw DecodingError.dataCorruptedError(
-        forKey: .version,
-        in: container,
-        debugDescription:
-          "This version of the formatter does not support configuration version \(version)."
+      throw SwiftFormatError.unsupportedConfigurationVersion(
+        version,
+        highestSupported: highestSupportedConfigurationVersion
       )
     }
 

Sources/SwiftFormat/API/SwiftFormatError.swift

@@ -28,6 +28,12 @@ public enum SwiftFormatError: LocalizedError {
   /// The requested experimental feature name was not recognized by the parser.
   case unrecognizedExperimentalFeature(String)
 
+  /// An error happened while dumping the tool's configuration.
+  case configurationDumpFailed(String)
+
+  /// The provided configuration version is not supported by this version of the formatter.
+  case unsupportedConfigurationVersion(Int, highestSupported: Int)
+
   public var errorDescription: String? {
     switch self {
     case .fileNotReadable:
@@ -38,6 +44,11 @@ public enum SwiftFormatError: LocalizedError {
       return "file contains invalid Swift syntax"
     case .unrecognizedExperimentalFeature(let name):
       return "experimental feature '\(name)' was not recognized by the Swift parser"
+    case .configurationDumpFailed(let message):
+      return "dumping configuration failed: \(message)"
+    case .unsupportedConfigurationVersion(let version, let highestSupported):
+      return
+        "This version of the formatter does not support configuration version \(version). The highest supported version is \(highestSupported)."
     }
   }
 }

Sources/SwiftFormat/CMakeLists.txt

@@ -1,14 +1,15 @@
 #[[
 This source file is part of the swift-format open source project
 
-Copyright (c) 2024 Apple Inc. and the swift-format project authors
+Copyright (c) 2024 - 2025 Apple Inc. and the swift-format project authors
 Licensed under Apache License v2.0 with Runtime Library Exception
 
 See https://swift.org/LICENSE.txt for license information
 #]]
 
 add_library(SwiftFormat
   API/Configuration+Default.swift
+  API/Configuration+Dump.swift
   API/Configuration.swift
   API/DebugOptions.swift
   API/Finding.swift

Sources/SwiftFormat/PrettyPrint/PrettyPrint.swift

@@ -819,7 +819,7 @@ public class PrettyPrinter {
     context.findingEmitter.emit(
       message,
       category: category,
-      location: Finding.Location(file: context.fileURL.path, line: outputBuffer.lineNumber, column: column)
+      location: Finding.Location(file: context.fileURL.relativePath, line: outputBuffer.lineNumber, column: column)
     )
   }
 }

Sources/SwiftFormat/Rules/BeginDocumentationCommentWithOneLineSummary.swift

@@ -11,6 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 import Foundation
+import Markdown
 import SwiftSyntax
 
 #if os(macOS)
@@ -91,14 +92,20 @@ public final class BeginDocumentationCommentWithOneLineSummary: SyntaxLintRule {
 
   /// Diagnose documentation comments that don't start with one sentence summary.
   private func diagnoseDocComments(in decl: DeclSyntax) {
+    // Extract the summary from a documentation comment, if it exists, and strip
+    // out any inline code segments (which shouldn't be considered when looking
+    // for the end of a sentence).
+    var inlineCodeRemover = InlineCodeRemover()
     guard
       let docComment = DocumentationComment(extractedFrom: decl),
-      let briefSummary = docComment.briefSummary
+      let briefSummary = docComment.briefSummary,
+      let noInlineCodeSummary = inlineCodeRemover.visit(briefSummary) as? Paragraph
     else { return }
 
     // For the purposes of checking the sentence structure of the comment, we can operate on the
     // plain text; we don't need any of the styling.
-    let trimmedText = briefSummary.plainText.trimmingCharacters(in: .whitespacesAndNewlines)
+    let trimmedText = noInlineCodeSummary.plainText
+      .trimmingCharacters(in: .whitespacesAndNewlines)
     let (commentSentences, trailingText) = sentences(in: trimmedText)
     if commentSentences.count == 0 {
       diagnose(.terminateSentenceWithPeriod(trimmedText), on: decl)
@@ -231,3 +238,9 @@ extension Finding.Message {
     "add a blank comment line after this sentence: \"\(text)\""
   }
 }
+
+struct InlineCodeRemover: MarkupRewriter {
+  mutating func visitInlineCode(_ inlineCode: InlineCode) -> Markup? {
+    nil
+  }
+}