SwiftSyntax

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

文档

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

与源文件的 SwiftSyntax 树进行交互式探索的绝佳方法是 https://swift-ast-explorer.com，由 @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"),
    ]),
  ]
)

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

文档

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

Product > Build Documentation

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

• SwiftSyntax
• SwiftParser
• SwiftOperators
• SwiftSyntaxMacros

贡献

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

报告问题

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

Bazel

SwiftSyntax 提供了由 Keith Smiley 维护的实验性 Bazel 构建配置。要使用它，您可以从对应版本标签中提取源压缩文件到您的 WORKSPACE，并在 BUILD.bazel 文件中依赖所需的库。每个库还关联一个 Library_opt 目标（如 SwiftSyntax_opt），这会使 SwiftSyntax 总是启用优化编译。这可能会以牺牲调试性为代价提高本地运行时的性能，并可能增加初始构建时间。请在与 Bazel 配置相关的问题标签中加上 "Bazel"。

许可

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