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

将<#指定发布标签#>替换为您想要使用的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”。

许可证

请参阅许可证以获取更多信息。