# useradgents/skot architecture

> Architecture diagram of the GitHub repository useradgents/skot, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/useradgents/skot
- Repository: https://github.com/useradgents/skot

## Overview

##### 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>.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "skot"
        subgraph "Foundation Layer"
            core["core\n(commonMain, platformMain)"]:::foundation
        end
        subgraph "Contracts Layer"
            modelcontract["modelcontract\n(SKData, SKStateDef)"]:::contracts
            viewcontract["viewcontract\n(UI components)"]:::contracts
        end
        subgraph "Implementations Layer"
            model["model\n(implements modelcontract)"]:::implementation
            viewmodel["viewmodel\n(MVVM wrappers)"]:::implementation
            viewlegacy["viewlegacy\n(Android UI impl)"]:::implementation
        end
        subgraph "Tooling Layer"
            generator["generator\n(code-gen CLI)"]:::tooling
            plugin["plugin\n(Gradle plugin)"]:::tooling
        end
    end

    %% Dependencies
    model -->|"implements"| modelcontract
    viewmodel -->|"implements"| viewcontract
    viewlegacy -->|"implements"| viewcontract
    viewmodel -->|"depends on"| core
    viewlegacy -->|"depends on"| core
    model -->|"depends on"| core
    plugin -->|"invokes"| generator

    %% Shared Build Logic and Scripts
    buildSrc["buildSrc"]:::infra
    scripts["check.sh"]:::infra
    buildSrc -->|"shared build logic"| core
    buildSrc -->|"shared build logic"| modelcontract
    buildSrc -->|"shared build logic"| viewcontract
    buildSrc -->|"shared build logic"| model
    buildSrc -->|"shared build logic"| viewlegacy
    buildSrc -->|"shared build logic"| viewmodel
    buildSrc -->|"shared build logic"| generator
    buildSrc -->|"shared build logic"| plugin
    scripts -->|"CI checks"| core
    scripts -->|"CI checks"| model
    scripts -->|"CI checks"| viewlegacy
    scripts -->|"CI checks"| viewmodel

    %% Testing Modules
    coreAndroidTest["core/src/androidInstrumentedTest"]:::testing
    coreJvmTest["core/src/jvmTest"]:::testing
    modelAndroidTest["model/src/androidInstrumentedTest"]:::testing
    modelJvmTest["model/src/jvmTest"]:::testing
    modelContractJvmTest["modelcontract/src/jvmTest"]:::testing
    viewlegacyAndroidTest["viewlegacy/src/androidInstrumentedTest"]:::testing
    viewlegacyTests["viewlegacyTests"]:::testing
    viewmodelJavaTest["viewmodel/src/javaTest"]:::testing
    viewmodelJvmTest["viewmodelTests"]:::testing

    coreAndroidTest -.-> core
    coreJvmTest -.-> core
    modelAndroidTest -.-> model
    modelJvmTest -.-> model
    modelContractJvmTest -.-> modelcontract
    viewlegacyAndroidTest -.-> viewlegacy
    viewlegacyTests -.-> viewlegacy
    viewmodelJavaTest -.-> viewmodel
    viewmodelJvmTest -.-> viewmodel

    %% External Distribution
    JitPack((JitPack)):::external
    core -->|"publishes artifact"| JitPack
    modelcontract -->|"publishes artifact"| JitPack
    viewcontract -->|"publishes artifact"| JitPack
    model -->|"publishes artifact"| JitPack
    viewlegacy -->|"publishes artifact"| JitPack
    viewmodel -->|"publishes artifact"| JitPack
    plugin -->|"publishes artifact"| JitPack
    generator -->|"publishes artifact"| JitPack

    %% Project Settings
    libsVersions["gradle/libs.versions.toml"]:::infra
    settingsFile["settings.gradle.kts"]:::infra
    jitpackConfig["jitpack.yml"]:::infra
    libsVersions --> skot
    settingsFile --> skot
    jitpackConfig --> skot

    %% Click Events
    click core "https://github.com/useradgents/skot/tree/ua/develop/core/"
    click modelcontract "https://github.com/useradgents/skot/tree/ua/develop/modelcontract/"
    click viewcontract "https://github.com/useradgents/skot/tree/ua/develop/viewcontract/"
    click model "https://github.com/useradgents/skot/tree/ua/develop/model/"
    click viewlegacy "https://github.com/useradgents/skot/tree/ua/develop/viewlegacy/"
    click viewmodel "https://github.com/useradgents/skot/tree/ua/develop/viewmodel/"
    click generator "https://github.com/useradgents/skot/tree/ua/develop/generator/"
    click plugin "https://github.com/useradgents/skot/tree/ua/develop/plugin/"
    click buildSrc "https://github.com/useradgents/skot/tree/ua/develop/buildSrc/"
    click scripts "https://github.com/useradgents/skot/blob/ua/develop/scripts/check.sh"
    click coreAndroidTest "https://github.com/useradgents/skot/tree/ua/develop/core/src/androidInstrumentedTest/"
    click coreJvmTest "https://github.com/useradgents/skot/tree/ua/develop/core/src/jvmTest/"
    click modelAndroidTest "https://github.com/useradgents/skot/tree/ua/develop/model/src/androidInstrumentedTest/"
    click modelJvmTest "https://github.com/useradgents/skot/tree/ua/develop/model/src/jvmTest/"
    click modelContractJvmTest "https://github.com/useradgents/skot/tree/ua/develop/modelcontract/src/jvmTest/"
    click viewlegacyAndroidTest "https://github.com/useradgents/skot/tree/ua/develop/viewlegacy/src/androidInstrumentedTest/"
    click viewlegacyTests "https://github.com/useradgents/skot/tree/ua/develop/viewlegacyTests/"
    click viewmodelJavaTest "https://github.com/useradgents/skot/tree/ua/develop/viewmodel/src/javaTest/"
    click viewmodelJvmTest "https://github.com/useradgents/skot/tree/ua/develop/viewmodelTests/"
    click libsVersions "https://github.com/useradgents/skot/blob/ua/develop/gradle/libs.versions.toml"
    click settingsFile "https://github.com/useradgents/skot/blob/ua/develop/settings.gradle.kts"
    click jitpackConfig "https://github.com/useradgents/skot/blob/ua/develop/jitpack.yml"

    %% Styles
    classDef foundation fill:#d3d3d3,stroke:#333,stroke-width:1px
    classDef contracts fill:#fff2b2,stroke:#333,stroke-width:1px
    classDef implementation fill:#d2f8d2,stroke:#333,stroke-width:1px
    classDef tooling fill:#b2dffd,stroke:#333,stroke-width:1px
    classDef testing fill:#ffd2a6,stroke:#333,stroke-width:1px,stroke-dasharray: 5 5
    classDef infra fill:#e0e0e0,stroke:#333,stroke-width:1px
    classDef external fill:#ccccff,stroke:#333,stroke-width:1px,stroke-dasharray: 2 2
```
