Merge remote-tracking branch 'upstream/main' into wasm32-wasi

.github/workflows/create-release-commits.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+set -ex
+
+SWIFT_SYNTAX_TAG="$1"
+SWIFT_FORMAT_VERSION="$2"
+
+if [[ -z "$SWIFT_SYNTAX_TAG" || -z "$SWIFT_FORMAT_VERSION" ]]; then
+  echo "Update the Package manifest to reference a specific version of swift-syntax and embed the given version in the swift-format --version command"
+  echo "Usage create-release-commits.sh <SWIFT_SYNTAX_TAG> <SWIFT_FORMAT_VERSION>"
+  echo "  SWIFT_SYNTAX_TAG:     The tag of swift-syntax to depend on"
+  echo "  SWIFT_FORMAT_VERSION: The version of swift-format that is about to be released"
+  exit 1
+fi
+
+# Without this, we can't perform git operations in GitHub actions.
+git config --global --add safe.directory "$(realpath .)"
+
+git config --local user.name 'swift-ci'
+git config --local user.email '[email protected]'
+
+sed -E -i "s#branch: \"(main|release/[0-9]+\.[0-9]+)\"#from: \"$SWIFT_SYNTAX_TAG\"#" Package.swift
+git add Package.swift
+git commit -m "Change swift-syntax dependency to $SWIFT_SYNTAX_TAG"
+
+sed -E -i "s#print\(\".*\"\)#print\(\"$SWIFT_FORMAT_VERSION\"\)#" Sources/swift-format/PrintVersion.swift
+git add Sources/swift-format/PrintVersion.swift
+git commit -m "Change version to $SWIFT_FORMAT_VERSION"

.github/workflows/publish_release.yml

@@ -0,0 +1,110 @@
+name: Publish Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      prerelease:
+        type: boolean
+        description: "Prerelease"
+        # Whether to create a prerelease or proper release
+        default: true
+        required: true
+      swift_format_version:
+        type: string
+        default: 601.0.0
+        description: "swift-format version"
+        # The version of swift-format to tag. If this is a prerelease, `-prerelease-<date>` is added to this version.
+        required: true
+      swift_syntax_tag:
+        type: string
+        default: 601.0.0
+        description: "swift-syntax version"
+        # The swift-syntax version to depend on. If this is a prerelease, the latest swift-syntax prerelease tag for this version is used.
+        required: true
+
+jobs:
+  check_triggering_actor:
+    name: Check user is allowed to create release
+    # Only a single user should be allowed to create releases to avoid two people triggering the creation of a release
+    # at the same time. If the release manager changes between users, update this condition.
+    runs-on: ubuntu-latest
+    steps:
+      - run: |
+          if [[ "${{ github.triggering_actor }}" != "ahoppen" ]]; then
+            echo "${{ github.triggering_actor }} is not allowed to create a release"
+            exit 1
+          fi
+  define_tags:
+    name: Determine dependent swift-syntax version and prerelease date
+    runs-on: ubuntu-latest
+    outputs:
+      swift_syntax_tag: ${{ steps.swift_syntax_tag.outputs.swift_syntax_tag }}
+      swift_format_version: ${{ steps.swift_format_version.outputs.swift_format_version }}
+    steps:
+    - name: Determine swift-syntax tag to depend on
+      id: swift_syntax_tag
+      shell: bash
+      run: |
+        if [[ "${{ github.event.inputs.prerelease }}" == "false" ]]; then
+          SWIFT_SYNTAX_TAG="${{ github.event.inputs.swift_syntax_tag }}"
+        else
+          git clone https://github.com/swiftlang/swift-syntax.git
+          cd swift-syntax
+          SWIFT_SYNTAX_TAG="$(git tag | grep ${{ github.event.inputs.swift_syntax_tag }}-prerelease | sort -r | head -1)"
+        fi
+
+        echo "Using swift-syntax tag: $SWIFT_SYNTAX_TAG"
+        echo "swift_syntax_tag=$SWIFT_SYNTAX_TAG" >> "$GITHUB_OUTPUT"
+    - name: Determine swift-format prerelease version
+      id: swift_format_version
+      run: |
+        if [[ "${{ github.event.inputs.prerelease }}" == "false" ]]; then
+          SWIFT_FORMAT_VERSION="${{ github.event.inputs.swift_format_version }}"
+        else
+          SWIFT_FORMAT_VERSION="${{ github.event.inputs.swift_format_version }}-prerelease-$(date +'%Y-%m-%d')"
+        fi
+        echo "Using swift-format version: $SWIFT_FORMAT_VERSION"
+        echo "swift_format_version=$SWIFT_FORMAT_VERSION" >> "$GITHUB_OUTPUT"
+  test_debug:
+    name: Test in Debug configuration
+    uses: swiftlang/github-workflows/.github/workflows/swift_package_test.yml@main
+    needs: define_tags
+    with:
+      pre_build_command: bash .github/workflows/create-release-commits.sh '${{ needs.define_tags.outputs.swift_syntax_tag }}' '${{ needs.define_tags.outputs.swift_format_version }}'
+      # We require that releases of swift-format build without warnings
+      build_command: swift test -Xswiftc -warnings-as-errors
+  test_release:
+    name: Test in Release configuration
+    uses: swiftlang/github-workflows/.github/workflows/swift_package_test.yml@main
+    needs: define_tags
+    with:
+      pre_build_command: bash .github/workflows/create-release-commits.sh '${{ needs.define_tags.outputs.swift_syntax_tag }}' '${{ needs.define_tags.outputs.swift_format_version }}'
+      # We require that releases of swift-format build without warnings
+      build_command: swift test -c release -Xswiftc -warnings-as-errors
+  create_tag:
+    name: Create Tag
+    runs-on: ubuntu-latest
+    needs: [check_triggering_actor, test_debug, test_release, define_tags]
+    permissions:
+      contents: write
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+    - name: Create release commits
+      run: bash .github/workflows/create-release-commits.sh '${{ needs.define_tags.outputs.swift_syntax_tag }}' '${{ needs.define_tags.outputs.swift_format_version }}'
+    - name: Tag release
+      run: |
+        git tag "${{ needs.define_tags.outputs.swift_format_version }}"
+        git push origin "${{ needs.define_tags.outputs.swift_format_version }}"
+    - name: Create release
+      env:
+        GH_TOKEN: ${{ github.token }}
+      run: |
+        if [[ "${{ github.event.inputs.prerelease }}" != "true" ]]; then
+          # Only create a release automatically for prereleases. For real releases, release notes should be crafted by hand.
+          exit
+        fi
+        gh release create "${{ needs.define_tags.outputs.swift_format_version }}" \
+          --title "${{ needs.define_tags.outputs.swift_format_version }}" \
+          --prerelease
+

.github/workflows/pull_request.yml

@@ -0,0 +1,16 @@
+name: Pull request
+
+on:
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+jobs:
+  tests:
+    name: Test
+    uses: swiftlang/github-workflows/.github/workflows/swift_package_test.yml@main
+  soundness:
+    name: Soundness
+    uses: swiftlang/github-workflows/.github/workflows/soundness.yml@main
+    with:
+      license_header_check_enabled: false
+      license_header_check_project_name: "Swift.org"

.swift-format

@@ -0,0 +1,18 @@
+{
+    "version": 1,
+    "lineLength": 120,
+    "indentation": {
+        "spaces": 2
+    },
+    "lineBreakBeforeEachArgument": true,
+    "indentConditionalCompilationBlocks": false,
+    "prioritizeKeepingFunctionOutputTogether": true,
+    "rules": {
+        "AlwaysUseLowerCamelCase": false,
+        "AmbiguousTrailingClosureOverload": false,
+        "NoBlockComments": false,
+        "OrderedImports": true,
+        "UseLetInEveryBoundCaseVariable": false,
+        "UseSynthesizedInitializer": false
+    }
+}

CODEOWNERS

@@ -0,0 +1,14 @@
+#
+# This source file is part of the Swift.org open source project
+#
+# Copyright (c) 2024 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 Swift project authors
+#
+
+* @ahoppen @allevato @bnbarham @shawnhyam
+
+.github/ @shahmishal
+.swiftci/ @shahmishal

Documentation/PrettyPrinter.md

@@ -490,6 +490,6 @@ sense to place this label on the containing group.
 
 Oppen's algorithm prints the indentation whitespace when `break` tokens are
 encountered. If we have extra blank lines in between source code, this can
-result in hanging or trailing whitespace. Waiting to print the indentation
+result in hanging or trailing whitespace. Waiting to print the indentation <!--# ignore-unacceptable-language -->
 whitespace until encountering a `syntax`, `comment, or `verbatim` tokens
 prevents this.

Package.swift

@@ -18,7 +18,7 @@ let package = Package(
   name: "swift-format",
   platforms: [
     .macOS("12.0"),
-    .iOS("13.0")
+    .iOS("13.0"),
   ],
   products: [
     .executable(
@@ -48,6 +48,7 @@ let package = Package(
     .target(
       name: "SwiftFormat",
       dependencies: [
+        .target(name: "WASIHelpers", condition: .when(platforms: [.wasi])),
         .product(name: "Markdown", package: "swift-markdown"),
         .product(name: "SwiftSyntax", package: "swift-syntax"),
         .product(name: "SwiftSyntaxBuilder", package: "swift-syntax"),
@@ -106,7 +107,6 @@ let package = Package(
       dependencies: [
         "_SwiftFormatInstructionCounter",
         "SwiftFormat",
-        .target(name: "WASIHelpers", condition: .when(platforms: [.wasi])),
         .product(name: "ArgumentParser", package: "swift-argument-parser"),
         .product(name: "SwiftSyntax", package: "swift-syntax"),
         .product(name: "SwiftParser", package: "swift-syntax"),
@@ -171,15 +171,12 @@ var dependencies: [Package.Dependency] {
   }
 }
 
-
-
 // MARK: - Compute custom build settings
 
-var swiftformatLinkSettings: [LinkerSetting]  {
+var swiftformatLinkSettings: [LinkerSetting] {
   if installAction {
     return [.unsafeFlags(["-no-toolchain-stdlib-rpath"], .when(platforms: [.linux, .android]))]
   } else {
     return []
   }
 }
-

Plugins/FormatPlugin/plugin.swift

@@ -1,28 +1,27 @@
-import PackagePlugin
 import Foundation
+import PackagePlugin
 
 @main
 struct FormatPlugin {
   func format(tool: PluginContext.Tool, targetDirectories: [String], configurationFilePath: String?) throws {
     let swiftFormatExec = URL(fileURLWithPath: tool.path.string)
-    
+
     var arguments: [String] = ["format"]
-    
+
     arguments.append(contentsOf: targetDirectories)
-    
+
     arguments.append(contentsOf: ["--recursive", "--parallel", "--in-place"])
-    
+
     if let configurationFilePath = configurationFilePath {
       arguments.append(contentsOf: ["--configuration", configurationFilePath])
     }
-    
+
     let process = try Process.run(swiftFormatExec, arguments: arguments)
     process.waitUntilExit()
-    
+
     if process.terminationReason == .exit && process.terminationStatus == 0 {
       print("Formatted the source code.")
-    }
-    else {
+    } else {
       let problem = "\(process.terminationReason):\(process.terminationStatus)"
       Diagnostics.error("swift-format invocation failed: \(problem)")
     }
@@ -35,15 +34,16 @@ extension FormatPlugin: CommandPlugin {
     arguments: [String]
   ) async throws {
     let swiftFormatTool = try context.tool(named: "swift-format")
-    
+
     var argExtractor = ArgumentExtractor(arguments)
     let targetNames = argExtractor.extractOption(named: "target")
-    let targetsToFormat = targetNames.isEmpty ? context.package.targets : try context.package.targets(named: targetNames)
-
+    let targetsToFormat =
+      targetNames.isEmpty ? context.package.targets : try context.package.targets(named: targetNames)
+
     let configurationFilePath = argExtractor.extractOption(named: "swift-format-configuration").first
-    
-    let sourceCodeTargets = targetsToFormat.compactMap{ $0 as? SourceModuleTarget }
-    
+
+    let sourceCodeTargets = targetsToFormat.compactMap { $0 as? SourceModuleTarget }
+
     try format(
       tool: swiftFormatTool,
       targetDirectories: sourceCodeTargets.map(\.directory.string),
@@ -58,10 +58,10 @@ import XcodeProjectPlugin
 extension FormatPlugin: XcodeCommandPlugin {
   func performCommand(context: XcodeProjectPlugin.XcodePluginContext, arguments: [String]) throws {
     let swiftFormatTool = try context.tool(named: "swift-format")
-    
+
     var argExtractor = ArgumentExtractor(arguments)
     let configurationFilePath = argExtractor.extractOption(named: "swift-format-configuration").first
-    
+
     try format(
       tool: swiftFormatTool,
       targetDirectories: [context.xcodeProject.directory.string],

Plugins/LintPlugin/plugin.swift

@@ -1,28 +1,27 @@
-import PackagePlugin
 import Foundation
+import PackagePlugin
 
 @main
 struct LintPlugin {
   func lint(tool: PluginContext.Tool, targetDirectories: [String], configurationFilePath: String?) throws {
     let swiftFormatExec = URL(fileURLWithPath: tool.path.string)
-    
+
     var arguments: [String] = ["lint"]
-    
+
     arguments.append(contentsOf: targetDirectories)
-    
+
     arguments.append(contentsOf: ["--recursive", "--parallel", "--strict"])
-    
+
     if let configurationFilePath = configurationFilePath {
       arguments.append(contentsOf: ["--configuration", configurationFilePath])
     }
-    
+
     let process = try Process.run(swiftFormatExec, arguments: arguments)
     process.waitUntilExit()
-    
+
     if process.terminationReason == .exit && process.terminationStatus == 0 {
       print("Linted the source code.")
-    }
-    else {
+    } else {
       let problem = "\(process.terminationReason):\(process.terminationStatus)"
       Diagnostics.error("swift-format invocation failed: \(problem)")
     }
@@ -35,16 +34,17 @@ extension LintPlugin: CommandPlugin {
     arguments: [String]
   ) async throws {
     let swiftFormatTool = try context.tool(named: "swift-format")
-    
+
     // Extract the arguments that specify what targets to format.
     var argExtractor = ArgumentExtractor(arguments)
     let targetNames = argExtractor.extractOption(named: "target")
-
-    let targetsToFormat = targetNames.isEmpty ? context.package.targets : try context.package.targets(named: targetNames)
+
+    let targetsToFormat =
+      targetNames.isEmpty ? context.package.targets : try context.package.targets(named: targetNames)
     let configurationFilePath = argExtractor.extractOption(named: "swift-format-configuration").first
-    
+
     let sourceCodeTargets = targetsToFormat.compactMap { $0 as? SourceModuleTarget }
-    
+
     try lint(
       tool: swiftFormatTool,
       targetDirectories: sourceCodeTargets.map(\.directory.string),
@@ -61,7 +61,7 @@ extension LintPlugin: XcodeCommandPlugin {
     let swiftFormatTool = try context.tool(named: "swift-format")
     var argExtractor = ArgumentExtractor(arguments)
     let configurationFilePath = argExtractor.extractOption(named: "swift-format-configuration").first
-    
+
     try lint(
       tool: swiftFormatTool,
       targetDirectories: [context.xcodeProject.directory.string],