SwiftSyntax

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

文档

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

探索源文件中 SwiftSyntax 树的一个交互式方法是 https://swift-ast-explorer.com，由 @kishikawakatsumi 开发。

添加 SwiftSyntax 依赖

主干开发（main）

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

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

文档

SwiftSyntax使用DocC捆绑包进行其文档。要观看Xcode中的渲染文档，请打开SwiftSyntax包并选择

Product > Build Documentation

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

• SwiftSyntax
• SwiftParser
• SwiftOperators
• SwiftSyntaxMacros

贡献

要开始为 SwiftSyntax 贡献，请查看 本指南 获取更多信息。

报告问题

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

Bazel

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

许可协议

请参阅 LICENSE 获取更多信息。