Rule Request: observable_object_main_actor
Nobody has claimed this yet.
- Dominant language
- Swift
- Stars
- 19.7k
- Forks
- 2.3k
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 11
Description
New Issue Checklist
- Updated SwiftLint to the latest version
- I searched for existing GitHub issues
New rule request
- Why should this rule be added? Share links to existing discussion about what
the community thinks about this.
From many WWDC21 talks around SwiftUI & async/await, a common practice was ensuring that an ObservableObject was run on the main actor by marking the class with @MainActor
- Provide several examples of what would and wouldn't trigger violations.
Good
@MainActor
class ViewModel: ObservableObject {
//...
}
@MainActor
class SomeOtherThing {
//...
}
Bad
class ViewModel: ObservableObject {
//...
}
- Should the rule be configurable, if so what parameters should be configurable?
nothing at this time
- Should the rule be opt-in or enabled by default? Why?
See README.md for guidelines on when to mark a rule as opt-in.
I think this rule should be opt in. async/await & actors are not yet fully supported on all iOS versions so lots of code would need to adapt for this rule to be useful.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with README.md's opt-in rules guidance, then locate the existing SwiftLint rule implementations and their tests for comparable class or actor checks. Use the provided good and bad Swift examples to define the expected behavior. Done means the opt-in rule consistently flags ObservableObject types without @MainActor while leaving the shown valid examples unflagged.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100