Write Viewmodel
Developmentwrite-viewmodelWrite Viewmodel is an Agent Skill for development published in the igorescodro/alkaa repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Use when writing a new ViewModel or modifying an existing one in the Alkaa project. Triggers on tasks like "add a ViewModel", "create VM for X screen", "implement state handling", or "connect use case to UI".
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/igorescodro/alkaa/blob/HEAD/.claude/skills/write-viewmodel/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/write-viewmodel, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Write ViewModel
Overview
ViewModels in Alkaa bridge domain use cases and Compose UI via cold flows and sealed state classes. They contain no business logic — only orchestration, mapping, and scope management.
Structure
- Sealed State Class —
data objectfor stateless states,data classfor states with data,ImmutableListfor list payloads → seereferences/CODE_PATTERNS.md - Flow Exposure — Cold
Flow<ViewState>by default; hotStateFlowonly when multiple collectors share the same stream → seereferences/CODE_PATTERNS.md - Use Case Injection — Inject use cases as constructor parameters; never repositories or other ViewModels → see
references/CODE_PATTERNS.md - Coroutine Scope —
applicationScopefor DB mutations that survive ViewModel destruction;viewModelScopefor UI-bound work → seereferences/CODE_PATTERNS.md - Mappers — Dedicated mapper class injected as constructor param; never map inline → see
references/CODE_PATTERNS.md
For unit test setup and fake patterns → see references/CODE_PATTERNS.md and the write-unit-tests skill.
Scope Rules
| Situation | Scope |
|---|---|
| DB insert / update / delete | applicationScope.launch { } |
| Network call that should persist | applicationScope.launch { } |
| Debounced UI updates | viewModelScope |
| Short-lived UI-bound work | viewModelScope |
Common Mistakes
| Mistake | Fix |
|---|---|
| Calling repository directly | Wrap in a use case first |
Exposing StateFlow for a screen-scoped stream | Return cold Flow<ViewState> |
| Mapping models inline in ViewModel | Create a XxxMapper class |
Using viewModelScope for DB writes | Use applicationScope.launch { } |
| Depending on another ViewModel | Extract shared logic into a use case |
| Testing with mocks | Write a XxxFake that implements the use case interface |
Related Skills
- Fake patterns and test structure → use
write-unit-testsskill - Composable and screen wiring → use
write-composableskill