SwiftSyntax

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

文档

您可以在 swiftpackageindex.com 上阅读 SwiftSyntax 的文档。

可以通过 https://swift-ast-explorer.com 来交互式地探索源文件的 SwiftSyntax 树，该网站由 @kishikawakatsumi 开发。

将 SwiftSyntax 添加为依赖项

主干开发（主要分支）

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用于原生解析源代码
• SwiftOperators用于折叠包含运算符的SwiftSyntax树
• SwiftSyntaxBuilder用于以结果构建器风格的界面生成Swift代码
• SwiftSyntaxMacros用于提供语法宏支持

发布版本

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

将<#指定发布标签#>替换为您想使用的SwiftSyntax版本（详细信息请参见下表）。

文档

SwiftSyntax使用DocC包来提供其文档。要在Xcode中查看渲染的文档，请打开SwiftSyntax包并选择

Product > Build Documentation

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

• SwiftSyntax
• SwiftParser
• SwiftOperators
• SwiftSyntaxMacros

贡献

开始为 SwiftSyntax 贡献，请参阅 此指南 以获取更多信息。

报告问题

如果在使用 SwiftSyntax 时遇到任何问题，请在 GitHub 问题 上提交错误报告。

Bazel

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

许可证

有关更多信息，请参阅 LICENSE。