SwiftSyntax

SwiftSyntax 是一组 Swift 库，用于解析、检查、生成和转换 Swift 源代码。

注意：SwiftSyntax 仍在开发中，其 API 不保证稳定。它可能会在没有警告的情况下进行更改。

SwiftSyntax 的主线分支跟踪最新的开发进展。它不是官方版本，API 和行为可能会快速变化。要使用它，请将此存储库添加到您的项目的 Package.swift 清单中

// 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"),
    ]),
  ]
)

主线 SwiftSyntax 还包括

• 用于原生解析源代码的 SwiftParser
• 用于折叠包含运算符的 SwiftSyntax 树的 SwiftOperators
• 用于使用 result builder 风格的界面生成 Swift 代码的 SwiftSyntaxBuilder

SwiftSyntax 的发布版本与相应的语言和工具发布版本对齐，并且是稳定的。要使用它们，请将此存储库添加到您的项目的 Package.swift 清单中

// 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"),
    ]),
  ]
)

将 <#Specify Release tag#> 替换为您要使用的 SwiftSyntax 版本（有关映射详细信息，请参见下表）。

SwiftSyntax 使用 DocC 包进行文档编制。要在 Xcode 中查看呈现的文档，请打开 SwiftSyntax 包并选择

Product > Build Documentation

相关的文章以 markdown 编写，可以在浏览器、文本编辑器或 IDE 中查看。

• SwiftSyntax
• SwiftParser
• SwiftOperators

要开始为 SwiftSyntax 做出贡献，请参阅 本指南 了解更多信息。

如果您在使用 SwiftSyntax 时遇到任何问题，我们欢迎您在 GitHub Issue 上报告错误。

SwiftSyntax 提供了一个实验性的 Bazel 构建配置，由 Keith Smiley 维护。 要使用它，您可以从相关发布标签中将源代码存档提取到您的 WORKSPACE 中，并依赖于 BUILD.bazel 文件中您需要的库。 每个库还有一个相关的 Library_opt 目标（例如 SwiftSyntax_opt），该目标强制 SwiftSyntax 始终启用优化进行构建。 这可能有助于提高本地运行时性能，但会牺牲调试能力和初始构建时间。 请使用标签 "Bazel" 标记任何与 Bazel 配置相关的 问题。

请参阅 LICENSE 了解更多信息。