# melix/jdoctor architecture

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

- Interactive diagram: https://gitdiagram.com/melix/jdoctor
- Repository: https://github.com/melix/jdoctor

## Overview

##### Project type and purpose
- This is an open-source, multi-module Java library (“JDoctor”) whose goal is to help library authors and application developers model and render rich, actionable error/help messages.
- Key modules:
- jdoctor-core: defines the Problem/Solution model (interfaces and base classes)
- jdoctor-utils: builds on core; supplies builders and a simple text renderer
- jdoctor-bom: a Gradle “Bill of Materials” to align versions of JDoctor artifacts
- jdoctor-build-logic: custom Gradle/Kotlin build plugin(s) to simplify publishing

##### File structure
- Top-level Gradle settings, version catalogs, and wrapper files govern the build
- Four project directories under root:
- jdoctor-core
- jdoctor-utils
- jdoctor-bom
- jdoctor-build-logic
- Each module has its own build.gradle.kts and src/ structure
- Core and utils have both production (src/main/java[11]) and test code (src/test/groovy, src/testFixtures)
- gradle/libs.versions.toml & gradle.properties store shared version info
- Custom Gradle plugin code lives under jdoctor-build-logic/src/main/kotlin

##### README for additional insights
- The README calls out the three published modules (core, utils, bom) and encourages consumers to pick and choose
- It emphasizes that rendering is the consumer’s responsibility, with utils providing a convenience renderer

a. Main components:
- Module: jdoctor-core (model)
- Module: jdoctor-utils (builders + renderers)
- Module: jdoctor-bom (version alignment)
- Module: jdoctor-build-logic (Gradle plugins for publishing)
- Consumers (external apps/libraries that depend on jdoctor artifacts)
- Gradle build system, Maven Central (publishing target)
b. Relationships & interactions:
- jdoctor-utils → depends on → jdoctor-core
- jdoctor-build-logic → applies to → root build and subprojects → publishes → core, utils, bom
- jdoctor-bom → has no code dependency, only a platform/BOM POM published for alignment
- Consumers → import → jdoctor-core and/or jdoctor-utils and/or BOM
c. Architectural patterns & design principles:
- Layered modular design – separation of “model” (core) from “rendering”/“builders” (utils)
- Gradle platform (bom) for consistent version management
- Custom Gradle plugin encapsulates publishing/publishing logic (DRY build logic)
- Test fixtures and Java 11–specific code kept under dedicated source roots
d. Key technologies & frameworks:
- Java 8+ and Java 11 modules (multi-release)
- Gradle Kotlin DSL (build.gradle.kts)
- Version catalogs (libs.versions.toml)
- Groovy for tests
- Maven Central publishing via Gradle

## Diagram (Mermaid)

```mermaid
flowchart TB
    GR("Gradle\n(build system)"):::external
    BL("jdoctor-build-logic\n(Gradle plugin)"):::buildlogic
    BOM("jdoctor-bom\n(Gradle platform)"):::bom
    UT("jdoctor-utils\n(builders & renderer)"):::runtime
    CO("jdoctor-core\n(model layer)"):::runtime
    MC("Maven Central"):::external
    CU("Consumer\n(Apps/Libraries)"):::external

    GR -->|applies to| BL
    GR -->|applies to| BOM
    GR -->|applies to| UT
    GR -->|applies to| CO

    BL -->|configures publishing of| CO
    BL -->|configures publishing of| UT
    BL -->|configures publishing of| BOM

    UT -->|depends on| CO

    CO -->|publishes to| MC
    UT -->|publishes to| MC
    BOM -->|publishes to| MC

    CU -->|compile| CO
    CU -->|compile| UT
    CU -->|import platform| BOM

    click CO "https://github.com/melix/jdoctor/blob/main/jdoctor-core/build.gradle.kts"
    click CO "https://github.com/melix/jdoctor/blob/main/jdoctor-core/src/main/java/me/champeau/jdoctor/BaseProblem.java"
    click CO "https://github.com/melix/jdoctor/blob/main/jdoctor-core/src/main/java/me/champeau/jdoctor/Problem.java"
    click CO "https://github.com/melix/jdoctor/blob/main/jdoctor-core/src/main/java11/me/champeau/jdoctor/Bogus.java"
    click CO "https://github.com/melix/jdoctor/blob/main/jdoctor-core/src/test/groovy/me/champeau/jdoctor/BaseProblemTest.groovy"
    click CO "https://github.com/melix/jdoctor/blob/main/jdoctor-core/src/testFixtures/groovy/me/champeau/jdoctor/TestProblem.groovy"

    click UT "https://github.com/melix/jdoctor/blob/main/jdoctor-utils/build.gradle.kts"
    click UT "https://github.com/melix/jdoctor/blob/main/jdoctor-utils/src/main/java/me/champeau/jdoctor/builders/ProblemBuilder.java"
    click UT "https://github.com/melix/jdoctor/blob/main/jdoctor-utils/src/main/java/me/champeau/jdoctor/builders/SolutionBuilder.java"
    click UT "https://github.com/melix/jdoctor/blob/main/jdoctor-utils/src/main/java/me/champeau/jdoctor/render/SimpleTextRenderer.java"
    click UT "https://github.com/melix/jdoctor/blob/main/jdoctor-utils/src/java11/java/me/champeau/jdoctor/builders/Bogus.java"
    click UT "https://github.com/melix/jdoctor/blob/main/jdoctor-utils/src/test/groovy/me/champeau/jdoctor/render/SimpleTextRenderTest.groovy"

    click BOM "https://github.com/melix/jdoctor/blob/main/jdoctor-bom/build.gradle.kts"

    click BL "https://github.com/melix/jdoctor/blob/main/jdoctor-build-logic/build.gradle.kts"
    click BL "https://github.com/melix/jdoctor/blob/main/jdoctor-build-logic/settings.gradle.kts"
    click BL "https://github.com/melix/jdoctor/blob/main/jdoctor-build-logic/src/main/kotlin/me/champeau/JavaLibraryExtension.kt"
    click BL "https://github.com/melix/jdoctor/blob/main/jdoctor-build-logic/src/main/kotlin/me/champeau/publishing.gradle.kts"
    click BL "https://github.com/melix/jdoctor/blob/main/jdoctor-build-logic/src/main/kotlin/me/champeau/maven-central-publishing.gradle.kts"

    click GR "https://github.com/melix/jdoctor/blob/main/gradle/libs.versions.toml"
    click GR "https://github.com/melix/jdoctor/blob/main/gradle.properties"

    click GR "https://github.com/melix/jdoctor/blob/main/build.gradle.kts"
    click GR "https://github.com/melix/jdoctor/blob/main/settings.gradle.kts"

    classDef runtime fill:#add8e6,stroke:#000,stroke-width:1px
    classDef bom fill:#ffff99,stroke:#000,stroke-width:1px
    classDef buildlogic fill:#ffcc99,stroke:#000,stroke-width:1px
    classDef external fill:#d3d3d3,stroke:#000,stroke-width:1px
```
