Skip to content

Maintain SourceKit-mode as long as custom rules don't support SwiftSyntax #6212

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

Merged
merged 1 commit into from
Aug 30, 2025
+8 −8
Merged

Maintain SourceKit-mode as long as custom rules don't support SwiftSyntax #6212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Source/SwiftLintFramework/Rules/CustomRules.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ struct CustomRules: Rule, CacheDescriptionProvider, ConditionallySourceKitFree {
var isEffectivelySourceKitFree: Bool {
configuration.customRuleConfigurations.allSatisfy { config in
let effectiveMode = config.executionMode == .default
? (configuration.defaultExecutionMode ?? .swiftsyntax)
? (configuration.defaultExecutionMode ?? .sourcekit)
: config.executionMode
return effectiveMode == .swiftsyntax
}
Expand Down
14 changes: 7 additions & 7 deletions Tests/FrameworkTests/CustomRulesTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -685,7 +685,7 @@ final class CustomRulesTests: SwiftLintTestCase {
XCTAssertEqual(violations[1].location.character, 18)
}

func testCustomRuleDefaultsToSwiftSyntaxWhenNoModeSpecified() throws {
func testCustomRuleDefaultsToSourceKitWhenNoModeSpecified() throws {
// When NO execution mode is specified (neither default nor per-rule), it should default to swiftsyntax
let customRules: [String: Any] = [
"no_foo": [
Expand Down Expand Up @@ -713,8 +713,8 @@ final class CustomRulesTests: SwiftLintTestCase {
return
}

XCTAssertTrue(customRule.isEffectivelySourceKitFree,
"Rule should be effectively SourceKit-free when defaulting to swiftsyntax")
XCTAssertFalse(customRule.isEffectivelySourceKitFree,
"Rule depends on SourceKit")
}

func testCustomRuleWithMatchKindsUsesSwiftSyntaxWhenConfigured() throws {
Expand All @@ -740,8 +740,8 @@ final class CustomRulesTests: SwiftLintTestCase {
XCTAssertEqual(violations[0].location.character, 23) // Position of 'foo' in comment
}

func testCustomRuleWithKindFilteringDefaultsToSwiftSyntax() throws {
// When using kind filtering without specifying mode, it should default to swiftsyntax
func testCustomRuleWithKindFilteringDefaultsToSourceKit() throws {
// When using kind filtering without specifying mode, it should default to sourcekit
let customRules: [String: Any] = [
"no_keywords": [
"regex": "\\b\\w+\\b",
Expand Down Expand Up @@ -769,8 +769,8 @@ final class CustomRulesTests: SwiftLintTestCase {
return
}

XCTAssertTrue(customRule.isEffectivelySourceKitFree,
"Rule with kind filtering should default to swiftsyntax mode")
XCTAssertFalse(customRule.isEffectivelySourceKitFree,
"Rule with kind filtering should default to sourcekit mode")
}

func testCustomRuleWithExcludedMatchKindsUsesSwiftSyntaxWithDefaultMode() throws {
Expand Down