Skip to content
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.

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

Make implicitly confirming to Actor to trigger warning #5465

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@

#### Enhancements

* Make implicitly confirming to `Actor` to trigger warning.
[marunomi](https://github.com/marunomi)
[#issue_number](https://github.com/realm/SwiftLint/issues/issue_number)

* Add new option `ignore_typealiases_and_associatedtypes` to
`nesting` rule. It excludes `typealias` and `associatedtype`
declarations from the analysis.
Expand Down
15 changes: 15 additions & 0 deletions Source/SwiftLintBuiltInRules/Rules/Lint/MissingDocsRule.swift
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import SourceKittenFramework
import SwiftSyntax

private extension SwiftLintFile {
func missingDocOffsets(in dictionary: SourceKittenDictionary,
Expand Down Expand Up @@ -123,6 +124,12 @@ struct MissingDocsRule: OptInRule {
func validate(file: SwiftLintFile) -> [StyleViolation] {
let acls = configuration.parameters.map { $0.value }
let dict = file.structureDictionary
let isImplictlyActorDecleation: Bool = ClassDeclaratopmVisitor(viewMode: .sourceAccurate)
.walk(tree: file.syntaxTree, handler: \.isActorImplicitlyHerited)

if isImplictlyActorDecleation && configuration.excludesInheritedTypes {
return []
}
return file.missingDocOffsets(
in: dict,
acls: acls,
Expand All @@ -137,3 +144,11 @@ struct MissingDocsRule: OptInRule {
}
}
}

private class ClassDeclaratopmVisitor: SyntaxVisitor {
private(set) var isActorImplicitlyHerited = false

override func visitPost(_ node: ActorDeclSyntax) {
isActorImplicitlyHerited = true
}
}
21 changes: 21 additions & 0 deletions Tests/SwiftLintFrameworkTests/MissingDocsRuleTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,27 @@ class MissingDocsRuleTests: SwiftLintTestCase {
)
}

func testExcludesImplicitlyActorHelitedTrueByDefault() {
let baseDescription = MissingDocsRule.description
let nonTriggeringExamples = [
Example("""
/// Docs
public final actor MyActor {
public nonisolated var unownedExecutor: UnownedSerialExecutor { }
}
"""),
Example("""
/// Docs
public final actor MyActor: Actor {
public nonisolated var unownedExecutor: UnownedSerialExecutor { }
}
""")
]
let description = baseDescription.with(nonTriggeringExamples: nonTriggeringExamples)
verifyRule(description,
ruleConfiguration: ["excludes_inherited_types": true])
}

func testWithExcludesExtensionsDisabled() {
// Perform additional tests with the ignores_comments settings disabled.
let baseDescription = MissingDocsRule.description
Expand Down