Rebase with swift 6.1.1 release

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+
+# Match the maximum line length in Swift files.
+max-line-length = 120

.github/workflows/publish_release.yml

@@ -0,0 +1,152 @@
+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
+  create_release_commits:
+    name: Create release commits
+    runs-on: ubuntu-latest
+    outputs:
+      swift_format_version: ${{ steps.swift_format_version.outputs.swift_format_version }}
+      release_commit_patch: ${{ steps.create_release_commits.outputs.release_commit_patch }}
+    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"
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Create release commits
+        id: create_release_commits
+        run: |
+          # 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 'swift-ci@users.noreply.github.com'
+
+          BASE_COMMIT=$(git rev-parse HEAD)
+
+          sed -E -i "s#branch: \"(main|release/[0-9]+\.[0-9]+)\"#from: \"${{ steps.swift_syntax_tag.outputs.swift_syntax_tag }}\"#" Package.swift
+          git add Package.swift
+          git commit -m "Change swift-syntax dependency to ${{ steps.swift_syntax_tag.outputs.swift_syntax_tag }}"
+
+          sed -E -i "s#print\(\".*\"\)#print\(\"${{ steps.swift_format_version.outputs.swift_format_version }}\"\)#" Sources/swift-format/PrintVersion.swift
+          git add Sources/swift-format/PrintVersion.swift
+          git commit -m "Change version to ${{ steps.swift_format_version.outputs.swift_format_version }}"
+
+          {
+            echo 'release_commit_patch<<EOF'
+            git format-patch "$BASE_COMMIT"..HEAD --stdout
+            echo EOF
+          } >> "$GITHUB_OUTPUT"
+  test:
+    name: Test in ${{ matrix.release && 'Release' || 'Debug' }} configuration
+    uses: swiftlang/github-workflows/.github/workflows/swift_package_test.yml@main
+    needs: create_release_commits
+    strategy:
+      fail-fast: false
+      matrix:
+        release: [true, false]
+    with:
+      linux_pre_build_command: |
+        git config --global --add safe.directory "$(realpath .)"
+        git config --local user.name 'swift-ci'
+        git config --local user.email 'swift-ci@users.noreply.github.com'
+        git am << EOF
+        ${{ needs.create_release_commits.outputs.release_commit_patch }}
+        EOF
+      windows_pre_build_command: |
+        git config --local user.name "swift-ci"
+        git config --local user.email "swift-ci@users.noreply.github.com"
+        echo @"
+        ${{ needs.create_release_commits.outputs.release_commit_patch }}
+        "@ > $env:TEMP\patch.diff
+        # For some reason `git am` fails in Powershell with the following error. Executing it in cmd works...
+        # fatal: empty ident name (for <>) not allowed
+        cmd /c "type $env:TEMP\patch.diff | git am || (exit /b 1)"
+      # We require that releases of swift-format build without warnings
+      linux_build_command: swift test -Xswiftc -warnings-as-errors ${{ matrix.release && '-c release' || '' }}
+      windows_build_command: swift test -Xswiftc -warnings-as-errors ${{ matrix.release && '-c release' || '' }}
+  create_tag:
+    name: Create Tag
+    runs-on: ubuntu-latest
+    needs: [check_triggering_actor, test, create_release_commits]
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Apply release commits
+        run: |
+          git config --global --add safe.directory "$(realpath .)"
+          git config --local user.name 'swift-ci'
+          git config --local user.email 'swift-ci@users.noreply.github.com'
+          git am << EOF
+          ${{ needs.create_release_commits.outputs.release_commit_patch }}
+          EOF
+      - name: Tag release
+        run: |
+          git tag "${{ needs.create_release_commits.outputs.swift_format_version }}"
+          git push origin "${{ needs.create_release_commits.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.create_release_commits.outputs.swift_format_version }}" \
+            --title "${{ needs.create_release_commits.outputs.swift_format_version }}" \
+            --prerelease

.github/workflows/pull_request.yml

@@ -0,0 +1,17 @@
+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"
+      api_breakage_check_allowlist_path: "api-breakages.txt"

.pre-commit-hooks.yaml

@@ -0,0 +1,6 @@
+- id: swift-format
+  name: swift-format
+  entry: swift-format format --in-place --recursive --parallel
+  language: swift
+  types: [swift]
+  require_serial: true

.spi.yml

@@ -0,0 +1,11 @@
+# This is manifest file for the Swift Package Index for it to
+# auto-generate and host DocC documentation.
+# For reference see https://swiftpackageindex.com/swiftpackageindex/spimanifest/documentation/spimanifest/commonusecases#Host-DocC-documentation-in-the-Swift-Package-Index.
+
+version: 1
+builder:
+  configs:
+    - documentation_targets:
+        # First item in the list is the "landing" (default) target
+        - SwiftFormat
+      custom_documentation_parameters: [--experimental-skip-synthesized-symbols]

.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
+    }
+}

.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

@@ -0,0 +1,92 @@
+#[[
+This source file is part of the swift-format open source project
+
+Copyright (c) 2024 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
+#]]
+
+cmake_minimum_required(VERSION 3.19.0)
+
+if(POLICY CMP0077)
+  cmake_policy(SET CMP0077 NEW)
+endif()
+if(POLICY CMP0091)
+  cmake_policy(SET CMP0091 NEW)
+endif()
+
+project(SwiftFormat
+  LANGUAGES C Swift)
+
+set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
+set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)
+set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)
+
+set(CMAKE_Swift_MODULE_DIRECTORY ${CMAKE_BINARY_DIR}/swift)
+set(CMAKE_Swift_COMPILE_OPTIONS_MSVC_RUNTIME_LIBRARY MultiThreadedDLL)
+
+list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake/modules)
+
+include(FetchContent)
+include(GNUInstallDirs)
+include(SwiftSupport)
+
+find_package(Foundation CONFIG)
+
+set(_SF_VENDOR_DEPENDENCIES)
+
+set(BUILD_EXAMPLES NO)
+set(BUILD_TESTING NO)
+
+find_package(ArgumentParser CONFIG)
+if(NOT ArgumentParser_FOUND)
+  FetchContent_Declare(ArgumentParser
+    GIT_REPOSITORY https://github.com/apple/swift-argument-parser
+    GIT_TAG 1.2.3)
+  list(APPEND _SF_VENDOR_DEPENDENCIES ArgumentParser)
+endif()
+
+find_package(cmark-gfm CONFIG)
+if(NOT cmark-gfm_FOUND)
+  FetchContent_Declare(cmark-gfm
+    GIT_REPOSITORY https://github.com/apple/swift-cmark
+    GIT_TAG gfm)
+  list(APPEND _SF_VENDOR_DEPENDENCIES cmark-gfm)
+endif()
+
+find_package(SwiftMarkdown CONFIG)
+if(NOT SwiftMarkdown_FOUND)
+  # TODO(compnerd) we need a latest version for now as we need the CMake support
+  # which is untagged.
+  FetchContent_Declare(Markdown
+    GIT_REPOSITORY https://github.com/apple/swift-markdown
+    GIT_TAG main)
+  list(APPEND _SF_VENDOR_DEPENDENCIES Markdown)
+endif()
+
+find_package(SwiftSyntax CONFIG)
+if(NOT SwiftSyntax_FOUND)
+  FetchContent_Declare(Syntax
+    GIT_REPOSITORY https://github.com/swiftlang/swift-syntax
+    GIT_TAG main)
+  list(APPEND _SF_VENDOR_DEPENDENCIES Syntax)
+endif()
+
+if(_SF_VENDOR_DEPENDENCIES)
+  FetchContent_MakeAvailable(${_SF_VENDOR_DEPENDENCIES})
+
+  if(NOT TARGET SwiftMarkdown::Markdown)
+    add_library(SwiftMarkdown::Markdown ALIAS Markdown)
+  endif()
+
+  if(NOT TARGET SwiftSyntax::SwiftSyntax)
+    add_library(SwiftSyntax::SwiftSyntax ALIAS SwiftSyntax)
+    add_library(SwiftSyntax::SwiftSyntaxBuilder ALIAS SwiftSyntaxBuilder)
+    add_library(SwiftSyntax::SwiftOperators ALIAS SwiftOperators)
+    add_library(SwiftSyntax::SwiftParser ALIAS SwiftParser)
+    add_library(SwiftSyntax::SwiftParserDiagnostics ALIAS SwiftParserDiagnostics)
+  endif()
+endif()
+
+add_subdirectory(Sources)

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/ @ahoppen @bnbarham @shahmishal
+.swiftci/ @ahoppen @bnbarham @shahmishal