swiftlang/swift-package-manager

Update macro template to support Swift Testing tests

Open

#8,890 建立於 2025年7月2日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)Swift (10,145 star) (1,462 fork)batch import
enhancementgood first issueswift package init

描述

According to the SwiftPM code base, we are unable to use Swift Testing to verify macros. However, the referenced GitHub issue (https://github.com/swiftlang/swift-syntax/issues/2400) is closed.

The Swift Syntax 600 release notes mentions SwiftSyntaxMacrosGenericTestSupport.

Here is a snippet of the relevant Swift Syntax release notes

SwiftSyntaxMacrosGenericTestSupport

  • Description: A version of the SwiftSyntaxMacrosTestSupport module that doesn't depend on Foundation or XCTest and can thus be used to write macro tests using swift-testing. Since swift-syntax can't depend on swift-testing (which would incur a circular dependency since swift-testing depends on swift-syntax), users need to manually specify a failure handler like the following, that fails the swift-testing test: Issue.record("\($0.message)", fileID: $0.location.fileID, filePath: $0.location.filePath, line: $0.location.line, column: $0.location.column)
  • Pull request: https://github.com/swiftlang/swift-syntax/pull/2647

The SwiftPM template for swift package init --type macro should be update to provide an idiomatic way to write a Swift Testing test to verify and validate a macro.

貢獻者指南

技術棧
swift
領域
testingdeveloper experience
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Swift programmingSwiftPM template systemSwift Testing framework
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
68
研究方向
Start by examining the current macro template in `Sources/Workspace/InitPackage.swift` around lines 119-122. Review the Swift Syntax 600 release notes and the linked PR #2647 to understand the `SwiftSyntaxMacrosGenericTestSupport` module and the required failure handler. Then, update the template to include a simple macro test example using swift testing, following the pattern shown in the release notes.