# theaniketraj/vista architecture

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

- Interactive diagram: https://gitdiagram.com/theaniketraj/vista
- Repository: https://github.com/theaniketraj/vista

## Overview

##### Project Type & Purpose
- Type: A CLI Gradle plugin (VISTA) plus a sample Android app (“app” module) demonstrating its usage.
- Purpose: Automate semantic version increments via a `version.properties` file, integrate with Gradle build lifecycle, and publish to the Gradle Plugin Portal.

##### File Structure
Top-level elements
├─ settings.gradle.kts & Gradle Wrapper (`gradlew`, `gradle/`) – orchestrate multi-module build
├─ version.properties – central version store
├─ app/ – Android sample applying the plugin
├─ vista-plugin/ – plugin implementation and publishing config
└─ .github/workflows/vista-plugin.yml – CI pipeline definition

Key patterns
- Multi-module Gradle project
- Plugin extension points (Gradle Plugin Publish DSL + META-INF descriptors)
- CLI task entrypoint (`incrementVersion`)

##### Extract Insights from the README
- Core component: `com.example.vista.VersioningPlugin` class
- Main tasks: `incrementVersion`
- Publishing metadata under `META-INF/gradle-plugins/`
- CI integration via GitHub Actions to build, test, and publish

A. Developer Workstation
– Runs `./gradlew <task>` via the Gradle Wrapper
B. Gradle Wrapper & Settings
– bootstraps Gradle, loads modules, resolves plugins
C. Plugin Module (vista-plugin)
– Contains `VersioningPlugin.kt`
– Descriptor in `META-INF/gradle-plugins/com.example.vista.versioning.properties`
– Implements Gradle’s Plugin<Project> interface
D. version.properties File
– Holds `VERSION_MAJOR`, `VERSION_MINOR`, `VERSION_PATCH`, `BUILD_NUMBER`
– Read/write by `incrementVersion` task
E. Sample Android App Module (app)
– Applies `com.example.vista.versioning` plugin
– Triggers version increment during its build lifecycle
F. CI/CD Pipeline (GitHub Actions)
– Triggers on push/tags
– Executes `./gradlew build publishPlugin`
G. Gradle Plugin Portal (External Service)
– Receives published plugin artifacts via Gradle Plugin Publish

##### Architectural Patterns & Design Principles
- Modularization: separate plugin logic (`vista-plugin`) from sample consumer (`app`)
- Plugin Pattern: implements Gradle’s plugin contract, defines tasks and extensions
- Configuration-as-Code: uses `version.properties`, Gradle DSL, and `META-INF` descriptors
- CI/CD Pipeline: declarative build/test/publish steps in GitHub Actions

##### Essential Elements
- Clear component names (e.g., VersioningPlugin, version.properties)
- Annotations for key technologies (Kotlin, Gradle, GitHub Actions)

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Developer Workstation"
        Dev["Developer Workstation"]:::infra
    end

    subgraph "Gradle Wrapper & Settings"
        Wrapper["Gradle Wrapper (./gradlew)"]:::infra
        Settings["settings.gradle.kts"]:::infra
    end

    subgraph "Plugin Module (vista-plugin)"
        VersioningPlugin["VersioningPlugin.kt"]:::code
        PluginDescriptor["com.example.vista.versioning.properties"]:::code
        PluginBuild["build.gradle.kts"]:::code
    end

    VersionProperties["version.properties"]:::config

    subgraph "Sample Android App (app)"
        AppBuild["app/build.gradle.kts"]:::code
        AppDescriptor["com.example.vista.versioning.properties"]:::code
    end

    subgraph "CI/CD Pipeline (GitHub Actions)"
        CI["vista-plugin.yml"]:::infra
    end

    PluginPortal["Gradle Plugin Portal"]:::infra

    Dev -->|"./gradlew incrementVersion"| Wrapper
    Wrapper -->|"loads settings"| Settings
    Settings -->|"loads modules"| VersioningPlugin
    Settings -->|"loads modules"| AppBuild
    VersioningPlugin -->|"reads/writes version"| VersionProperties
    AppBuild -->|"applies plugin"| VersioningPlugin
    AppBuild -->|"invokes plugin task"| VersioningPlugin
    CI -->|"runs build & publish"| Wrapper
    VersioningPlugin -->|"publishes plugin"| PluginPortal
    CI -->|"publishes artifact"| PluginPortal

    click Wrapper "https://github.com/theaniketraj/vista/tree/main/./gradlew"
    click Wrapper "https://github.com/theaniketraj/vista/blob/main/gradle/wrapper/gradle-wrapper.properties"
    click Settings "https://github.com/theaniketraj/vista/blob/main/./settings.gradle.kts"
    click VersionProperties "https://github.com/theaniketraj/vista/blob/main/./version.properties"
    click VersioningPlugin "https://github.com/theaniketraj/vista/blob/main/vista-plugin/src/main/kotlin/com/example/VersioningPlugin.kt"
    click PluginDescriptor "https://github.com/theaniketraj/vista/blob/main/vista-plugin/src/main/resources/META-INF/gradle-plugins/com.example.vista.versioning.properties"
    click PluginBuild "https://github.com/theaniketraj/vista/blob/main/vista-plugin/build.gradle.kts"
    click AppBuild "https://github.com/theaniketraj/vista/blob/main/app/build.gradle.kts"
    click AppDescriptor "https://github.com/theaniketraj/vista/blob/main/app/src/main/res/META-INF/gradle-plugins/com.example.vista.versioning.properties"
    click CI "https://github.com/theaniketraj/vista/blob/main/.github/workflows/vista-plugin.yml"

    classDef code fill:#bbdefb,stroke:#333,stroke-width:1px;
    classDef infra fill:#c8e6c9,stroke:#333,stroke-width:1px;
    classDef config fill:#fff9c4,stroke:#333,stroke-width:1px;
```
