Skip to content

Emit a diagnostic if an exit test's body closure includes a capture list. #1046

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Apr 1, 2025
Merged

Emit a diagnostic if an exit test's body closure includes a capture list. #1046

merged 1 commit into from
Apr 1, 2025

Conversation

@grynspan
Copy link
Contributor

@grynspan grynspan commented Apr 1, 2025 •
edited
Loading

This PR adds a custom diagnostic for #expect(exitsWith:) if the passed closure visibly closes over any state (via a capture list). For example:

await #expect(exitsWith: .failure) { [x] in
  // ...
}

Produces:

🛑 Cannot specify a capture clause in closure passed to '#expect(exitsWith:_:)'

With a fix-it to remove the capture list.

Checklist:

  • Code and documentation should follow the style of the Style Guide.
  • If public symbols are renamed or modified, DocC references should be updated.

@grynspan
Emit a diagnostic if an exit test's body closure includes a capture l…
6042a51 
…ist.

This PR adds a custom diagnostic for `#expect(exitsWith:)` if the passed closure
visibly closes over any state (via a capture list). For example:

```swift
await #expect(exitsWith: .failure) { [x] in
  // ...
}
```

Produces:

>  🛑 Cannot specify a capture clause in closure passed to '#expect(exitsWith:_:)'

With a fix-it to remove the capture list.
@grynspan grynspan added enhancement New feature or request exit-tests ☠️ Work related to exit tests macros 🔭 Related to Swift macros such as @Test or #expect labels Apr 1, 2025
@grynspan grynspan added this to the Swift 6.2 milestone Apr 1, 2025
@grynspan grynspan self-assigned this Apr 1, 2025
@grynspan
Copy link
Contributor Author

grynspan commented Apr 1, 2025

@swift-ci test

@grynspan grynspan merged commit 0e3bdfd into main Apr 1, 2025
3 checks passed
@grynspan grynspan deleted the jgrynspan/capture-list-diagnostic branch April 1, 2025 18:05
@grynspan grynspan added the exit-test-capture-lists 🥍 Work related to exit test capture lists label Jun 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@briancroom briancroom briancroom approved these changes

@stmontgomery stmontgomery Awaiting requested review from stmontgomery stmontgomery is a code owner

@SeanROlszewski SeanROlszewski Awaiting requested review from SeanROlszewski

@suzannaratcliff suzannaratcliff Awaiting requested review from suzannaratcliff

Assignees

@grynspan grynspan

Labels

enhancement New feature or request exit-test-capture-lists 🥍 Work related to exit test capture lists exit-tests ☠️ Work related to exit tests macros 🔭 Related to Swift macros such as @Test or #expect

Projects

None yet

Milestone

Swift 6.2.0

Development

Successfully merging this pull request may close these issues.

3 participants

@grynspan @briancroom