How useradgents/skot works
Project Type and Purpose
• This is a Kotlin Multiplatform library/framework (“skot”) that provides:
– A core library of utilities (core module)
– Contracts and implementations for data modeling (modelcontract & model)
– Contracts and implementations for UI components (viewcontract & viewlegacy)
– A multiplatform MVVM layer (viewmodel)
– Code‐generation tooling (generator module)
– A Gradle plugin (plugin module) for scaffolding & generation
• The framework is distributed via JitPack and used by Kotlin/Android/iOS consumers.
High‐Level Component Breakdown
A. Foundation Layer
– core (commonMain + platformMain targets)
• Utilities: formats, logging, URIs, DI injector
B. Contracts Layer
– modelcontract (defines SKData, SKStateDef, serializers)
– viewcontract (defines UI components: SKButtonVC, SKScreenVC, resources)
C. Implementation Layer
– model (implements modelcontract for common, Android, iOS, JVM)
– viewlegacy (Android-specific view implementations of viewcontract)
– viewmodel (multiplatform MVVM wrappers of viewcontract components)
D. Tooling Layer
– generator (command‐line/tool to generate boilerplate code: components, viewmodels, resources)
– plugin (Gradle plugin orchestrating generator, project scaffolding, build integration)
E. Testing Modules
– androidTests, viewlegacyTests, viewmodelTests, core/jvmTest, etc.
• Validate cross‐platform behavior on Android emulator or JVM
Dependency Relationships
• core ← used by → modelcontract, viewcontract, viewmodel, viewlegacy, model
• modelcontract ← implemented by → model
• viewcontract ← implemented by → viewlegacy & viewmodel
• model & viewmodel ← may reference → core injector & utilities
• plugin → invokes → generator
• generator → reads project template + docs → emits code under new projects
• buildSrc holds shared build‐logic (Versions.kt) for all modules
• scripts/check.sh for CI checks
Architectural Patterns & Principles
• Layered architecture: foundation → contracts → implementations → tooling
• MVVM: viewcontract + viewmodel implement unidirectional data flow
• Dependency Injection: core/di modules provide Injector and Module abstractions
• Code generation: separation of concerns between templates (generator) and build‐time plugin
Detail
• Every top‐level directory/module from the file tree appears.
• DI modules under core/di and model/di.
• If desired, illustrate sample code‐generation flow: plugin task → calls generator.Generate → writes to src/<newProject>.