SwiftSyntax is a set of Swift libraries for parsing, inspecting, generating, and transforming Swift source code.

Note: SwiftSyntax is still in development, and its API is not guaranteed to be stable. It is subject to change without warning.

The mainline branch of SwiftSyntax tracks the latest developments. It is not an official release, and is subject to rapid changes in APIs and behaviors. To use it, add this repository to the Package.swift manifest of your project:

// swift-tools-version:5.7
import PackageDescription

let package = Package(
  name: "MyTool",
  dependencies: [
    .package(url: "https://github.com/apple/swift-syntax.git", branch: "main"),
  ],
  targets: [
    .target(name: "MyTool", dependencies: [
      .product(name: "SwiftSyntax", package: "swift-syntax"),
    ]),
  ]
)

Mainline SwiftSyntax also includes

• SwiftParser for natively parsing source code
• SwiftOperators for folding SwiftSyntax trees containing operators
• SwiftSyntaxBuilder for generating Swift code with a result builder-style interface

Releases of SwiftSyntax are aligned with corresponding language and tooling releases and are stable. To use them, add this repository to the Package.swift manifest of your project:

// swift-tools-version:5.7
import PackageDescription

let package = Package(
  name: "MyTool",
  dependencies: [
    .package(url: "https://github.com/apple/swift-syntax.git", exact: "<#Specify Release tag#>"),
  ],
  targets: [
    .target(name: "MyTool", dependencies: [
      .product(name: "SwiftSyntax", package: "swift-syntax"),
    ]),
  ]
)

Replace <#Specify Release tag#> by the version of SwiftSyntax that you want to use (see the following table for mapping details).

Documentation can be found in the following places:

• For the parser: Sources/SwiftParser/SwiftParser.docc
  • You can either directly view this documentation on GitHub or build a documentation bundle by opening the project in Xcode and clicking Product -> Build Documentation
• General documentation: Documentation
• Examples of using SwiftSyntax: Examples.

Start contributing to SwiftSyntax see this guide for more information.

If you should hit any issues while using SwiftSyntax, we appreciate bug reports on GitHub Issue.

Please see LICENSE for more information.