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

将 <#Specify Release tag#> 替换为您要使用的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。