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

将<#指定发布标签#>替换为您要使用的SwiftSyntax版本（见下表以获取映射详细信息）。

文档

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

Product > Build Documentation

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

• SwiftSyntax
• SwiftParser
• SwiftOperators
• SwiftSyntaxMacros

参与贡献

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

问题反馈

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

Bazel

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

许可协议

更多详细信息，请参阅 许可协议。