# picnicsupermarket/error-prone-support architecture

> Architecture diagram of the GitHub repository picnicsupermarket/error-prone-support, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-16). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/picnicsupermarket/error-prone-support
- Repository: https://github.com/picnicsupermarket/error-prone-support

## Overview

##### Main Components

The system architecture should be divided into these key components:

a. Core Components:
- Error Prone Contrib (Main bug checker implementations)
- Refaster Support (Core functionality for code transformation)
- Documentation Support (Documentation generation tools)
- Utils (Shared utilities and helpers)

b. Testing Components:
- Refaster Test Support
- Integration Tests

c. Build & Deployment:
- Maven Build System
- GitHub Actions Workflows

##### Component Relationships

**[Core Components]**
**┌─────────────────────┐     ┌─────────────────────┐**
- Error Prone Contrib│◄────┤   Refaster Support  │
- ┘     └─────────────────────┘
- ▲                           ▲

**┌─────────────────────┐     ┌─────────────────────┐**
- Utils          │◄────┤      Documentation  │
- ┘     │      Support        │
- ┘

**[Testing Infrastructure]**
**┌─────────────────────┐     ┌─────────────────────┐**
- Refaster Test      │◄────┤   Integration       │
- Support            │     │   Tests             │
- ┘     └─────────────────────┘

**[Build & Deployment]**
**┌─────────────────────┐     ┌─────────────────────┐**
- Maven Build        │◄────┤   GitHub Actions    │
- System            │     │   Workflows         │
- ┘     └─────────────────────┘

##### Component Details

For each component, include:
- Name
- Primary responsibility
- Key interfaces/classes
- Dependencies on other components

##### Data Flow

Following interactions:
- Source code input
- Static analysis processing
- Bug detection output
- Code transformation suggestions
- Documentation generation
- Test execution flow

##### Integration Points

Integration with:
- Google Error Prone
- Maven/Gradle build systems
- IDE tooling
- CI/CD pipelines

##### Notes

Annotations for:
- Required Java version (JDK 17+)
- Build system requirements
- Key configuration points
- Extension points

##### Integration points with external tools

- How the components interact
- Where to add new features
- How to extend existing functionality
- Testing and deployment workflows

- Using consistent styling
- Providing adequate spacing
- Including clear labels
- Adding concise descriptions

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Core
        EPC["Error Prone Contrib"]:::core
        RS["Refaster Support"]:::core
        DS["Documentation Support"]:::core
        Utils["Utils"]:::core
        
        RS --> EPC
        Utils --> EPC
        Utils --> RS
        Utils --> DS
    end

    subgraph Testing
        RTS["Refaster Test Support"]:::testing
        IT["Integration Tests"]:::testing
        
        RTS --> IT
    end

    subgraph Build
        Maven["Maven Build System"]:::build
        GHA["GitHub Actions"]:::build
        
        Maven --> GHA
    end

    Core --> Testing
    Testing --> Build

    classDef core fill:#a8d1f0,stroke:#4a90e2
    classDef testing fill:#b8e986,stroke:#7ed321
    classDef build fill:#ffd7a8,stroke:#f5a623

    click EPC "https://github.com/PicnicSupermarket/error-prone-support/tree/master/error-prone-contrib/"
    click RS "https://github.com/PicnicSupermarket/error-prone-support/tree/master/refaster-support/"
    click DS "https://github.com/PicnicSupermarket/error-prone-support/tree/master/documentation-support/"
    click Utils "https://github.com/PicnicSupermarket/error-prone-support/tree/master/error-prone-utils/"
    click RTS "https://github.com/PicnicSupermarket/error-prone-support/tree/master/refaster-test-support/"
    click IT "https://github.com/PicnicSupermarket/error-prone-support/tree/master/integration-tests/"
    click GHA "https://github.com/PicnicSupermarket/error-prone-support/tree/master/.github/workflows/"
    click Maven "https://github.com/PicnicSupermarket/error-prone-support/blob/master/pom.xml"

    %% Legend
    subgraph Legend
        L1["Core Components"]:::core
        L2["Testing Components"]:::testing
        L3["Build Components"]:::build
    end
```
