# uteke/gradle-kotlin-convention-plugins architecture

> Architecture diagram of the GitHub repository uteke/gradle-kotlin-convention-plugins, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/uteke/gradle-kotlin-convention-plugins
- Repository: https://github.com/uteke/gradle-kotlin-convention-plugins

## Overview

##### Project type and purpose
- This is a multi-module Gradle project that provides a set of Kotlin DSL “conventions” plugins (build-logic) and an Android application (app) that demonstrates their usage.
- Its goal is to centralize and standardize Gradle dependency declarations and build configurations via reusable plugins.

##### File structure
Top-level:
- settings.gradle.kts, build.gradle.kts, gradle.properties, gradlew* – standard Gradle wrapper and settings.
- build-logic/ – a self-contained included build defining custom Gradle plugins in Kotlin.
- app/ – an Android application module.
build-logic/src/main/kotlin:
- AppConfig.kt, VersionCatalogExtensions.kt – shared constants & version handling.
- kotlin-conventions.gradle.kts, kotlin-library-conventions.gradle.kts, kotlin-android-library-conventions.gradle.kts, test-conventions.gradle.kts – plugin implementations.
app/src – typical Android project (MainActivity, Fragments, resources).

##### README for additional insights
- Four convention plugins are declared:
- kotlin-conventions
- kotlin-library-conventions
- kotlin-android-library-conventions
- test-conventions
- These are published internally and then applied in module build scripts to enforce consistent configurations.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Actors
    Dev["Developer & CI/CD"]:::actor

    %% Build System Components
    subgraph "Build System"
        direction TB
        GW["Gradle Wrapper"]:::build
        Settings["settings.gradle.kts"]:::build
        Props["gradle.properties & build.gradle.kts"]:::build
        Catalog["Version Catalog\nlibs.versions.toml"]:::catalog
    end

    %% Included Build: build-logic
    subgraph "Included Build: build-logic"
        direction TB
        BL_Settings["settings.gradle.kts"]:::plugin
        BL_Build["build.gradle.kts"]:::plugin
        AppConfig["AppConfig.kt"]:::code
        VersionExt["VersionCatalogExtensions.kt"]:::code
        KC["kotlin-conventions.gradle.kts"]:::plugin
        KLib["kotlin-library-conventions.gradle.kts"]:::plugin
        KA_LIB["kotlin-android-library-conventions.gradle.kts"]:::plugin
        TestConv["test-conventions.gradle.kts"]:::plugin
    end

    %% App Module
    subgraph "App Module: app"
        direction TB
        AppBuild["app/build.gradle.kts"]:::app
        ProGuard["app/proguard-rules.pro"]:::app
        Manifest["AndroidManifest.xml"]:::app
        MainAct["MainActivity.kt"]:::app
        Frag1["FirstFragment.kt"]:::app
        Frag2["SecondFragment.kt"]:::app
        Resources["res/**"]:::app
        UnitTest["ExampleUnitTest.kt"]:::test
    end

    %% External Systems
    AndroidSDK["Android SDK"]:::external
    Maven["Maven Central"]:::external

    %% Relationships
    Dev -->|"runs ./gradlew build"| GW
    GW --> Settings
    GW --> Props
    Settings -->|"includes build-logic"| BL_Settings
    Props --> Catalog
    Catalog --> BL_Build
    BL_Settings --> BL_Build
    BL_Build --> AppConfig
    BL_Build --> VersionExt
    BL_Build --> KC
    BL_Build --> KLib
    BL_Build --> KA_LIB
    BL_Build --> TestConv

    %% Plugin artifacts resolution
    KC -->|"plugin artifact"| AppBuild
    KLib -->|"plugin artifact"| AppBuild
    KA_LIB -->|"plugin artifact"| AppBuild
    TestConv -->|"plugin artifact"| UnitTest

    %% Version catalog consumption
    Catalog -->|"dependency versions"| AppBuild
    VersionExt -->|"extensions"| AppBuild

    %% App compile & dependencies
    AppBuild -->|"compile via"| AndroidSDK
    AppBuild -->|"fetch externals"| Maven

    %% Tests
    UnitTest -->|"uses test-conventions"| TestConv

    %% Click events
    click GW "https://github.com/uteke/gradle-kotlin-convention-plugins/tree/main/gradlew"
    click GW "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/gradlew.bat"
    click GW "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/gradle/wrapper/gradle-wrapper.jar"
    click GW "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/gradle/wrapper/gradle-wrapper.properties"
    click Settings "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/settings.gradle.kts"
    click Props "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/build.gradle.kts"
    click Props "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/gradle.properties"
    click Catalog "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/gradle/libs.versions.toml"
    click BL_Settings "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/build-logic/settings.gradle.kts"
    click BL_Build "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/build-logic/build.gradle.kts"
    click AppConfig "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/build-logic/src/main/kotlin/AppConfig.kt"
    click VersionExt "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/build-logic/src/main/kotlin/VersionCatalogExtensions.kt"
    click KC "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/build-logic/src/main/kotlin/kotlin-conventions.gradle.kts"
    click KLib "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/build-logic/src/main/kotlin/kotlin-library-conventions.gradle.kts"
    click KA_LIB "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/build-logic/src/main/kotlin/kotlin-android-library-conventions.gradle.kts"
    click TestConv "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/build-logic/src/main/kotlin/test-conventions.gradle.kts"
    click AppBuild "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/app/build.gradle.kts"
    click ProGuard "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/app/proguard-rules.pro"
    click Manifest "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/app/src/main/AndroidManifest.xml"
    click MainAct "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/app/src/main/java/com/uteke/conventions/MainActivity.kt"
    click Frag1 "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/app/src/main/java/com/uteke/conventions/FirstFragment.kt"
    click Frag2 "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/app/src/main/java/com/uteke/conventions/SecondFragment.kt"
    click Resources "https://github.com/uteke/gradle-kotlin-convention-plugins/tree/main/app/src/main/res"
    click UnitTest "https://github.com/uteke/gradle-kotlin-convention-plugins/blob/main/app/src/test/java/com/uteke/conventions/ExampleUnitTest.kt"

    %% Styles
    classDef actor fill:#DDEBF7,stroke:#4472C4,color:#000
    classDef build fill:#FFF2CC,stroke:#BF9000,color:#000
    classDef catalog fill:#E2EFDA,stroke:#70AD47,color:#000
    classDef plugin fill:#FCE4D6,stroke:#C65911,color:#000
    classDef code fill:#E7E6E6,stroke:#7F7F7F,color:#000
    classDef app fill:#DBE5F1,stroke:#5B9BD5,color:#000
    classDef test fill:#F4DCFF,stroke:#7030A0,color:#000
    classDef external fill:#F2F2F2,stroke:#808080,color:#000
```
