Add "Toggle disabled test" code action#2541
Open
xlmtvv wants to merge 1 commit intoswiftlang:mainfrom
Open
Conversation
Add a syntactic code action that toggles test functions between enabled and disabled states. For Swift Testing, this adds or removes the .disabled() trait on the @test attribute. For XCTest, this inserts or removes a leading throw XCTSkip("Disabled") statement and adjusts throws accordingly. Resolves swiftlang#2524
Member
|
@swift-ci Please test |
rintaro
reviewed
Mar 16, 2026
| return declRef.baseName.text == "XCTSkip" | ||
| } | ||
| if let memberAccess = functionCall.calledExpression.as(MemberAccessExprSyntax.self) { | ||
| return memberAccess.declName.baseName.text == "XCTSkip" |
Member
There was a problem hiding this comment.
Is this handling module qualified calls i.e. XCTests.XCTSkip(...). If so, could you add test cases?
Comment on lines
+277
to
+291
| // Walk up to find the enclosing MemberBlockSyntax, then check its parent. | ||
| var node: Syntax? = Syntax(funcDecl).parent | ||
| while let current = node { | ||
| if let memberBlock = current.as(MemberBlockSyntax.self) { | ||
| let parent = memberBlock.parent | ||
| return parent?.is(ClassDeclSyntax.self) == true | ||
| || parent?.is(ExtensionDeclSyntax.self) == true | ||
| } | ||
| // Stop at code blocks to avoid matching nested functions. | ||
| if current.is(CodeBlockSyntax.self) { | ||
| return false | ||
| } | ||
| node = current.parent | ||
| } | ||
| return false |
Member
There was a problem hiding this comment.
Suggested change
| // Walk up to find the enclosing MemberBlockSyntax, then check its parent. | |
| var node: Syntax? = Syntax(funcDecl).parent | |
| while let current = node { | |
| if let memberBlock = current.as(MemberBlockSyntax.self) { | |
| let parent = memberBlock.parent | |
| return parent?.is(ClassDeclSyntax.self) == true | |
| || parent?.is(ExtensionDeclSyntax.self) == true | |
| } | |
| // Stop at code blocks to avoid matching nested functions. | |
| if current.is(CodeBlockSyntax.self) { | |
| return false | |
| } | |
| node = current.parent | |
| } | |
| return false | |
| funcDecl.findParentOfSelf( | |
| ofType: Syntax.self, | |
| stoppingIf: { $0.is(CodeBlockSyntax.self) }, | |
| matching: { $0.is(ClassDeclSyntax.self) || $0.is(ExtensionDeclSyntax.self) } | |
| ) != nil |
Comment on lines
+252
to
+260
| let name = funcDecl.name.text | ||
| guard name.hasPrefix("test") else { | ||
| return nil | ||
| } | ||
|
|
||
| // XCTest methods must be inside a class or extension. | ||
| guard isDirectClassOrExtensionMember(funcDecl) else { | ||
| return nil | ||
| } |
Member
There was a problem hiding this comment.
It's a bit unfortunate that this is essentially duplicating the logic in SyntacticSwiftXCTestScanner, but I don't feel it's worth to reuse that for this simple task... fine for now
|
|
||
| /// Infer the indentation used inside a code block by examining the first | ||
| /// statement's leading trivia, or falling back to 4 spaces. | ||
| private static func inferIndentation(of body: CodeBlockSyntax) -> String { |
Member
There was a problem hiding this comment.
Could you use BasicFormat.inferIndentation(of:) from SwiftBasicFormat module?
| return true | ||
| } | ||
| // Don't descend into nested functions or closures. | ||
| if node.is(FunctionDeclSyntax.self) || node.is(ClosureExprSyntax.self) { |
Member
There was a problem hiding this comment.
I feel we can skip any DeclSyntax
Suggested change
| if node.is(FunctionDeclSyntax.self) || node.is(ClosureExprSyntax.self) { | |
| if node.is(DeclSyntax.self) || node.is(ClosureExprSyntax.self) { |
| guard | ||
| let funcDecl = scope.innermostNodeContainingRange?.findParentOfSelf( | ||
| ofType: FunctionDeclSyntax.self, | ||
| stoppingIf: { $0.is(CodeBlockSyntax.self) } |
Member
There was a problem hiding this comment.
This action is active at anywhere in the function signature including the attributes, but not in the body.
Maybe we might want to adjust it in the future, but I think it's fine for now. Could you add comment to clarify the cursor positions it's intended to be active?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a syntactic code action to toggle test functions between enabled and disabled states.
For Swift Testing, activating the action on a
@Testfunction adds.disabled()to the attribute (and removes it when the test is already disabled). For XCTest, it inserts a leadingthrow XCTSkip("Disabled")statement and addsthrowsto the signature (and reverses both when enabling).Conditional disables such as
.disabled(if: condition)are intentionally not treated as unconditional - the action will not offer "Enable test" for those.Resolves #2524