README
Structured Coroutines
A comprehensive toolkit for enforcing structured concurrency in Kotlin Coroutines, inspired by Swift Concurrency. It provides multiple layers of protection through compile-time checks and static analysis.
Project Status
| Module | Status | Documentation |
|---|---|---|
| Compiler Plugin | ✅ Complete (12 rules) | gradle-plugin/README.md |
| Gradle Plugin | ✅ Complete | gradle-plugin/README.md |
| Detekt Rules | ✅ Complete (19 rules) | detekt-rules/README.md |
| Android Lint | ✅ Complete (21 rules) | lint-rules/README.md |
| IntelliJ Plugin | ✅ Complete (15 inspections, 13 quick fixes, 6 intentions, tool window) | intellij-plugin/README.md |
| Annotations | ✅ Complete | annotations/README.md |
| Sample | ✅ Compilation examples per rule | compilation/README |
| Sample (Detekt) | ✅ Detekt rule validation (19 examples) | sample-detekt/README.md |
| Kotlin Coroutines Agent Skill | ✅ AI/agent guidance | docs/KOTLIN_COROUTINES_SKILL.md |
🎯 Purpose
Kotlin Coroutines are powerful but can be misused, leading to:
- Resource leaks from orphaned coroutines
- Uncontrolled lifecycle with
GlobalScope - Difficult debugging due to scattered coroutine launches
- Deadlocks from
runBlockingin suspend functions - Broken cancellation from swallowed
CancellationException - Thread starvation from blocking calls in coroutines
This toolkit enforces structured concurrency best practices through:
- Compiler Plugin - Errors at compile time (K2/FIR)
- Detekt Rules - Static analysis warnings
- Android Lint Rules - Android-specific static analysis with quick fixes
📦 Toolkit Components
| Module | Purpose | When |
|---|---|---|
compiler | K2/FIR Compiler Plugin | Compile-time errors |
detekt-rules | Detekt custom rules | Static analysis |
lint-rules | Android Lint rules | Android projects |
intellij-plugin | IntelliJ/Android Studio Plugin | Real-time IDE analysis |
annotations | @StructuredScope annotation | Runtime/Compile |
gradle-plugin | Gradle integration | Build configuration |