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获取更多信息。