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

将<#指定发布标签#>替换为您要使用的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获取更多信息。