# openrewrite/rewrite-gradle-plugin architecture

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

- Interactive diagram: https://gitdiagram.com/openrewrite/rewrite-gradle-plugin
- Repository: https://github.com/openrewrite/rewrite-gradle-plugin

## Overview

##### Project type and purpose
- This is a Gradle plugin project (“rewrite‑gradle‑plugin”) whose purpose is to integrate the OpenRewrite refactoring engine into a Gradle build as first‑class tasks (e.g. rewriteRun, rewriteDiscover, rewriteDryRun). It allows a consuming project to configure Rewrite recipes via a DSL extension and have them run automatically during the build.

##### File‑structure analysis
- Top‑level build scripts:
- settings.gradle.kts, build.gradle.kts, gradle.properties, wrapper under gradle/wrapper
- A buildSrc directory containing Groovy classes that generate version data and argument providers used in the publishing/build pipeline.
- plugin module (plugin/):
- src/main/java & src/main/kotlin: plugin entrypoint (RewritePlugin), extension (RewriteExtension), task classes (AbstractRewriteTask & subtypes), project parsers (GradleProjectParser, AndroidProjectParser, DelegatingProjectParser), classloader isolation (RewriteClassLoader), result containers, marker printers.
- src/test: JUnit/Kotlin tests for tasks and parser components, fixtures, sample projects.
- CI & publishing:
- .github/workflows/*.yml orchestrate CI builds, integration tests, publishing to Gradle Plugin Portal, Dependabot updates, backups, stale‑issue management.

##### README insights
- Clear explanation of plugin usage, configuration via rewrite { activeRecipe(...) }, consumption of snapshots via pluginManagement resolution strategy.
- References to core Rewrite engine (“Rewrite”), and documentation links.

##### Essential elements without over‑splitting
- Closely related classes (all Task implementations) under one “Rewrite Tasks” boundary.
- Both “GradleProjectParser” and “AndroidProjectParser” as options behind a “Parser” facade.
- Isolated classloader as a separate module to highlight dependency isolation.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Build System
    subgraph "Build System"
        Gradle["Gradle Build System"]:::build
        Settings["settings.gradle.kts"]:::build
        BuildScript["build.gradle.kts"]:::build
    end
    click Settings "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/settings.gradle.kts"
    click BuildScript "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/build.gradle.kts"

    %% Plugin Management & Resolution
    subgraph "Plugin Management & Resolution"
        PluginMgmt["PluginManagement & Resolution"]:::infra
    end
    click PluginMgmt "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/settings.gradle.kts"

    %% Plugin Artifact
    subgraph "Plugin Artifact"
        PluginJar["rewrite-gradle-plugin JAR"]:::artifact
    end
    click PluginJar "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/plugin/build.gradle.kts"

    %% Plugin Internals
    subgraph "Plugin Internals"
        RewritePlugin["RewritePlugin"]:::entry
        RewriteExt["RewriteExtension"]:::ext
        subgraph "Rewrite Tasks"
            AbstractTask["AbstractRewriteTask"]:::task
            RewriteRun["RewriteRunTask"]:::task
            RewriteDiscover["RewriteDiscoverTask"]:::task
            RewriteDry["RewriteDryRunTask"]:::task
        end
        subgraph "Project Parsers"
            DelegatingParser["DelegatingProjectParser"]:::parser
            GradleParser["GradleProjectParser"]:::parser
            AndroidParser["AndroidProjectParser"]:::parser
            DefaultParser["DefaultProjectParser"]:::parser
        end
        ClassLoader["RewriteClassLoader"]:::iso
        ResultsCont["ResultsContainer"]:::result
        MarkerPrinter["SanitizedMarkerPrinter"]:::result
    end
    click RewritePlugin "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/plugin/src/main/java/org/openrewrite/gradle/RewritePlugin.java"
    click RewriteExt "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/plugin/src/main/java/org/openrewrite/gradle/RewriteExtension.java"
    click AbstractTask "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/plugin/src/main/java/org/openrewrite/gradle/AbstractRewriteTask.java"
    click RewriteRun "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/plugin/src/main/java/org/openrewrite/gradle/RewriteRunTask.java"
    click RewriteDiscover "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/plugin/src/main/java/org/openrewrite/gradle/RewriteDiscoverTask.java"
    click RewriteDry "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/plugin/src/main/java/org/openrewrite/gradle/RewriteDryRunTask.java"
    click DelegatingParser "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/plugin/src/main/java/org/openrewrite/gradle/DelegatingProjectParser.java"
    click GradleParser "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/plugin/src/main/java/org/openrewrite/gradle/GradleProjectParser.java"
    click AndroidParser "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/plugin/src/main/java/org/openrewrite/gradle/isolated/AndroidProjectParser.java"
    click DefaultParser "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/plugin/src/main/java/org/openrewrite/gradle/isolated/DefaultProjectParser.java"
    click ClassLoader "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/plugin/src/main/java/org/openrewrite/gradle/RewriteClassLoader.java"
    click ResultsCont "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/plugin/src/main/java/org/openrewrite/gradle/isolated/ResultsContainer.java"
    click MarkerPrinter "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/plugin/src/main/java/org/openrewrite/gradle/SanitizedMarkerPrinter.java"

    %% External Runtime
    subgraph "External Runtime"
        Core["OpenRewrite Core Engine"]:::external
    end

    %% Output
    subgraph "Output"
        Patches["Patch Files / In-place Changes"]:::output
        Console["Console Reports"]:::output
    end

    %% buildSrc Utilities
    subgraph "buildSrc Utilities"
        VersionData["GradleVersionData"]:::util
        CLIProvider["GradleVersionsCommandLineArgumentProvider"]:::util
    end
    click VersionData "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/buildSrc/src/main/groovy/org/gradle/rewrite/build/GradleVersionData.groovy"
    click CLIProvider "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/buildSrc/src/main/groovy/org/gradle/rewrite/build/GradleVersionsCommandLineArgumentProvider.groovy"

    %% CI & Publishing
    subgraph "CI & Publishing"
        CI1["ci.yml"]:::ci
        CI2["integration-tests.yml"]:::ci
        CI3["publish.yml"]:::ci
        CI4["dependency-submission.yml"]:::ci
        CI5["repository-backup.yml"]:::ci
        CI6["stale.yml"]:::ci
    end
    click CI1 "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/.github/workflows/ci.yml"
    click CI2 "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/.github/workflows/integration-tests.yml"
    click CI3 "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/.github/workflows/publish.yml"
    click CI4 "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/.github/workflows/dependency-submission.yml"
    click CI5 "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/.github/workflows/repository-backup.yml"
    click CI6 "https://github.com/openrewrite/rewrite-gradle-plugin/blob/main/.github/workflows/stale.yml"

    %% Connections
    Gradle -->|"applies"| RewritePlugin
    Gradle -->|"uses"| PluginMgmt
    PluginMgmt -->|resolves| PluginJar
    RewritePlugin -->|"registers"| RewriteExt
    RewritePlugin -->|"registers"| AbstractTask
    RewriteExt -->|"configures tasks"| RewriteRun
    RewriteExt -->|"configures tasks"| RewriteDiscover
    RewriteExt -->|"configures tasks"| RewriteDry
    RewriteRun -->|"invokes parser"| DelegatingParser
    RewriteRun -->|"uses classloader"| ClassLoader
    DelegatingParser -->|"delegates to"| GradleParser
    DelegatingParser -->|"delegates to"| AndroidParser
    DelegatingParser -->|"delegates to"| DefaultParser
    ClassLoader -->|"loads"| Core
    Core -->|"returns diffs"| ResultsCont
    ResultsCont -->|"formats"| MarkerPrinter
    MarkerPrinter -->|"outputs"| Patches
    MarkerPrinter -->|"outputs"| Console

    %% Styles
    classDef build fill:#BBDEFB,stroke:#1E88E5,stroke-width:1px
    classDef infra fill:#B3E5FC,stroke:#039BE5,stroke-width:1px
    classDef artifact fill:#FFE0B2,stroke:#FB8C00,stroke-width:1px
    classDef entry fill:#C8E6C9,stroke:#43A047,stroke-width:1px
    classDef ext fill:#DCEDC8,stroke:#7CB342,stroke-width:1px
    classDef task fill:#E8F5E9,stroke:#66BB6A,stroke-width:1px
    classDef parser fill:#F1F8E9,stroke:#8BC34A,stroke-width:1px
    classDef iso fill:#FFF9C4,stroke:#FBC02D,stroke-width:1px
    classDef result fill:#F3E5F5,stroke:#8E24AA,stroke-width:1px
    classDef external fill:#E1BEE7,stroke:#8E24AA,stroke-width:1px
    classDef output fill:#FFF3E0,stroke:#FB8C00,stroke-width:1px
    classDef buildsrc fill:#ECEFF1,stroke:#607D8B,stroke-width:1px
    classDef util fill:#CFD8DC,stroke:#546E7A,stroke-width:1px
    classDef ci fill:#FFEBEE,stroke:#E53935,stroke-width:1px
```
