Migrate ExpiringTodoRule from SourceKit to SwiftSyntax #6113
+148
−63
Conversation
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
jpsim
force-pushed
the
migrate-expiringtodorule-from-sourcekit-to-swiftsyntax
branch
from
d02cf16 to
3369649
Compare
|
Needs #6114 to have Regex support everywhere. |
jpsim
force-pushed
the
migrate-expiringtodorule-from-sourcekit-to-swiftsyntax
branch
from
3369649 to
088b822
Compare
Generated by 🚫 Danger |
pennig
suggested changes
Jun 20, 2025
pennig
reviewed
Jun 20, 2025
SimplyDanny
reviewed
Jun 21, 2025
## Summary Convert ExpiringTodoRule to use SwiftSyntax and native Swift Regex instead of SourceKit and NSRegularExpression for improved performance and better multiline comment handling. ## Key Technical Improvements - **Native Swift Regex** replacing NSRegularExpression for modern Swift patterns - **Full file content matching** to handle multiline TODO/FIXME comments - **Typed regex output** using Regex<(Substring, Substring)> for type safety - **Enhanced comment detection** supporting comments across multiple lines - **Improved performance** with SwiftSyntax visitor pattern over SourceKit AST parsing ## Migration Details - Replaced `ASTRule` with `@SwiftSyntaxRule(optIn: true)` annotation - Implemented `ViolationsSyntaxVisitor` pattern for file traversal - Changed from per-comment processing to full file regex matching - Added robust position-in-comment verification using trivia analysis - Migrated from NSRegularExpression to native Swift Regex with typed captures - Maintained full compatibility with existing rule behavior and test cases
Turns out that the Regex approach was extremely slow.
jpsim
force-pushed
the
migrate-expiringtodorule-from-sourcekit-to-swiftsyntax
branch
from
b7206e9 to
e869ac1
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Convert ExpiringTodoRule to use SwiftSyntax for improved performance and better multiline comment handling.
Key Technical Improvements
Migration Details
ASTRulewith@SwiftSyntaxRule(optIn: true)annotationViolationsSyntaxVisitorpattern for file traversal