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
• 用于将包含运算符的SwiftSyntax树进行折叠的SwiftOperators
• 用于以结果构建器风格的界面生成Swift代码的SwiftSyntaxBuilder
• 用于提供语法宏支持的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提供了一种实验性的Bazel构建配置，由Keith Smiley维护。要使用它，您可以从相关版本标签下拉取源存档到您的WORKSPACE文件，并在BUILD.bazel文件中依赖所需的库。每个库还有一个相关的Library_opt目标（如SwiftSyntax_opt），强制SwiftSyntax始终启用优化进行构建。这可能有助于本地运行时性能，但可能会牺牲调试性和初始构建时间。请将有关Bazel配置的任何问题标注为“Bazel”。

许可

请参见LICENSE以获取更多信息。