kotlin-coroutines-skill

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 (14 FIR checkers)	gradle-plugin/README.md
Gradle Plugin	✅ Complete (profiles incl. Spring/Ktor)	gradle-plugin/README.md
Detekt Rules	✅ Complete (40 rules)	detekt-rules/README.md
Android Lint	✅ Complete (35 detectors)	lint-rules/README.md
IntelliJ Plugin	✅ Complete (35 inspections, tool window, Flow Analyzer)	intellij-plugin/README.md
Annotations	✅ Complete	annotations/README.md
Sample	✅ Compilation examples per rule	compilation/README
Sample (Detekt)	✅ Detekt rule validation (30+ 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 runBlocking in suspend functions
• Broken cancellation from swallowed CancellationException
• Thread starvation from blocking calls in coroutines

This toolkit enforces structured concurrency best practices through:

1. Compiler Plugin - Errors at compile time (K2/FIR)
2. Detekt Rules - Static analysis warnings
3. 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

---

✨ Features