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 提供了一个经验证的 Bazel 构建配置，由 Keith Smiley 维护。要使用它，您可以从相关的发布标签拉取源存档到您的 WORKSPACE 文件中，并在 BUILD.bazel 文件中依赖于您需要的库。每个库还有一个相关的 Library_opt 目标（如 SwiftSyntax_opt），这将强制 SwiftSyntax 启用优化始终进行构建。这可能会以调试性为代价，提高本地运行时性能，并缩短首次构建时间。请将任何与 Bazel 配置相关的问题标记为标签 "Bazel"。

许可协议

有关更多信息，请参阅 许可协议。