# yangziwen/diff-check architecture

> Architecture diagram of the GitHub repository yangziwen/diff-check, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/yangziwen/diff-check
- Repository: https://github.com/yangziwen/diff-check

## Overview

diff-check provides incremental Checkstyle and PMD analysis plus incremental JaCoCo coverage filtering, using Git changes as the shared basis. The main workflow is to select revisions, calculate changed lines, run an analyzer or coverage report, and present results. README also documents installing commit hooks and configuring the checks. Connections below are limited to README statements and source-index references; unsampled implementation details and hook wiring are not inferred.

Main entry points: [`diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/maven/DiffAgentMojo.java`](https://github.com/yangziwen/diff-check/blob/master/diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/maven/DiffAgentMojo.java) (JaCoCo agent mojo), [`diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/util/FilterUtil.java`](https://github.com/yangziwen/diff-check/blob/master/diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/util/FilterUtil.java) (Filter utilities), [`diff-core/src/main/java/io/github/yangziwen/diff/calculate/DiffCalculator.java`](https://github.com/yangziwen/diff-check/blob/master/diff-core/src/main/java/io/github/yangziwen/diff/calculate/DiffCalculator.java) (Diff calculator), [`diff-pmd/src/main/java/io/github/yangziwen/pmd/Main.java`](https://github.com/yangziwen/diff-check/blob/master/diff-pmd/src/main/java/io/github/yangziwen/pmd/Main.java) (PMD analyzer)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_diff["Change calculation"]
  node_diffcalc["Diff calculator"]
  node_diffentry["Diff entries"]
  node_diffhelper["Diff helper<br/>[DiffHelper.java]"]
  node_mergebase["Merge base"]
  node_blame["Blame calculator"]
end

subgraph group_checkstyle["Checkstyle analysis"]
  node_checkmain["Checkstyle CLI<br/>[Main.java]"]
  node_checkline["Changed-line filter"]
  node_checkwhole["Whole-diff filter"]
end

subgraph group_pmd["PMD analysis"]
  node_pmdmain["PMD analyzer<br/>[Main.java]"]
  node_pmdcli["PMD CLI"]
  node_pmdparams["PMD parameters<br/>[PMDParameters.java]"]
  node_pmdconfig["PMD configuration"]
  node_pmdfilter["Changed-line filter"]
  node_renderer["Report renderer"]
  node_difftext["Diff text output"]
end

subgraph group_jacoco["Coverage analysis"]
  node_agent["JaCoCo agent mojo<br/>[DiffAgentMojo.java]"]
  node_coveragefilter["Changed-code filter<br/>[DiffFilter.java]"]
  node_personfilter["Author filter<br/>[PersonFilter.java]"]
  node_filterutil["Filter utilities<br/>[FilterUtil.java]"]
  node_linewrapper["Line number wrapper"]
  node_collectionutil["Collection utilities"]
  node_jacocofilters["JaCoCo filter registry<br/>[Filters.java]"]
  node_reportmojo["Report mojo<br/>[ReportMojo.java]"]
end

node_developer(("Developer"))
node_git[("Git repository")]
node_maven(("Maven run"))

node_developer -->|"commits changes"| node_git
node_developer -->|"runs checks"| node_checkmain
node_git -->|"supplies revisions"| node_diffcalc
node_diffcalc -->|"produces entries"| node_diffentry
node_diffcalc -->|"uses helpers"| node_diffhelper
node_checkmain -->|"calculates changes"| node_diffcalc
node_checkmain -->|"uses filter"| node_checkline
node_checkmain -->|"uses filter"| node_checkwhole
node_checkline -->|"reads entries"| node_diffentry
node_developer -->|"runs analysis"| node_pmdcli
node_pmdcli -->|"dispatches analysis"| node_pmdmain
node_pmdmain -->|"extracts options"| node_pmdparams
node_pmdparams -->|"configures analyzer"| node_pmdconfig
node_pmdmain -->|"calculates changes"| node_diffcalc
node_pmdmain -->|"filters violations"| node_pmdfilter
node_pmdfilter -->|"reads entries"| node_diffentry
node_pmdmain -->|"selects renderer"| node_renderer
node_renderer -->|"creates renderer"| node_difftext
node_maven -->|"starts coverage"| node_agent
node_agent -->|"calculates changes"| node_diffcalc
node_agent -->|"resolves comparison"| node_mergebase
node_agent -->|"gets authorship"| node_blame
node_agent -->|"registers filter"| node_coveragefilter
node_agent -->|"registers filter"| node_personfilter
node_agent -->|"appends filters"| node_filterutil
node_coveragefilter -->|"uses utilities"| node_filterutil
node_personfilter -->|"uses utilities"| node_filterutil
node_filterutil -->|"registers filter"| node_jacocofilters
node_filterutil -->|"wraps line nodes"| node_linewrapper
node_filterutil -->|"checks collections"| node_collectionutil
node_maven -->|"requests report"| node_reportmojo

click node_diffcalc "https://github.com/yangziwen/diff-check/blob/master/diff-core/src/main/java/io/github/yangziwen/diff/calculate/DiffCalculator.java"
click node_diffentry "https://github.com/yangziwen/diff-check/blob/master/diff-core/src/main/java/io/github/yangziwen/diff/calculate/DiffEntryWrapper.java"
click node_diffhelper "https://github.com/yangziwen/diff-check/blob/master/diff-core/src/main/java/io/github/yangziwen/diff/calculate/DiffHelper.java"
click node_mergebase "https://github.com/yangziwen/diff-check/blob/master/diff-core/src/main/java/io/github/yangziwen/diff/calculate/MergeBaseCalculator.java"
click node_blame "https://github.com/yangziwen/diff-check/blob/master/diff-core/src/main/java/io/github/yangziwen/diff/calculate/BlameCalculator.java"
click node_checkmain "https://github.com/yangziwen/diff-check/blob/master/diff-checkstyle/src/main/java/io/github/yangziwen/checkstyle/Main.java"
click node_checkline "https://github.com/yangziwen/diff-check/blob/master/diff-checkstyle/src/main/java/io/github/yangziwen/checkstyle/filter/DiffLineFilter.java"
click node_checkwhole "https://github.com/yangziwen/diff-check/blob/master/diff-checkstyle/src/main/java/io/github/yangziwen/checkstyle/filter/WholeDiffFilter.java"
click node_pmdmain "https://github.com/yangziwen/diff-check/blob/master/diff-pmd/src/main/java/io/github/yangziwen/pmd/Main.java"
click node_pmdcli "https://github.com/yangziwen/diff-check/blob/master/diff-pmd/src/main/java/io/github/yangziwen/pmd/cli/PMDCommandLineInterface.java"
click node_pmdparams "https://github.com/yangziwen/diff-check/blob/master/diff-pmd/src/main/java/io/github/yangziwen/pmd/cli/PMDParameters.java"
click node_pmdconfig "https://github.com/yangziwen/diff-check/blob/master/diff-pmd/src/main/java/io/github/yangziwen/pmd/PMDConfiguration.java"
click node_pmdfilter "https://github.com/yangziwen/diff-check/blob/master/diff-pmd/src/main/java/io/github/yangziwen/pmd/filter/DiffLineFilter.java"
click node_renderer "https://github.com/yangziwen/diff-check/blob/master/diff-pmd/src/main/java/io/github/yangziwen/pmd/renderers/RendererFactory.java"
click node_difftext "https://github.com/yangziwen/diff-check/blob/master/diff-pmd/src/main/java/io/github/yangziwen/pmd/renderers/DiffTextRenderer.java"
click node_agent "https://github.com/yangziwen/diff-check/blob/master/diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/maven/DiffAgentMojo.java"
click node_coveragefilter "https://github.com/yangziwen/diff-check/blob/master/diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/filter/DiffFilter.java"
click node_personfilter "https://github.com/yangziwen/diff-check/blob/master/diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/filter/PersonFilter.java"
click node_filterutil "https://github.com/yangziwen/diff-check/blob/master/diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/util/FilterUtil.java"
click node_linewrapper "https://github.com/yangziwen/diff-check/blob/master/diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/util/LineNumberNodeWrapper.java"
click node_collectionutil "https://github.com/yangziwen/diff-check/blob/master/diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/util/CollectionUtil.java"
click node_jacocofilters "https://github.com/yangziwen/diff-check/blob/master/diff-jacoco-maven-plugin/src/main/java/org/jacoco/core/internal/analysis/filter/Filters.java"
click node_reportmojo "https://github.com/yangziwen/diff-check/blob/master/diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/maven/ReportMojo.java"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_diffcalc,node_diffentry,node_diffhelper,node_mergebase,node_blame toneBlue
class node_checkmain,node_checkline,node_checkwhole,node_git toneAmber
class node_pmdmain,node_pmdcli,node_pmdparams,node_pmdconfig,node_pmdfilter,node_renderer,node_difftext toneMint
class node_agent,node_coveragefilter,node_personfilter,node_filterutil,node_linewrapper,node_collectionutil,node_jacocofilters,node_reportmojo toneRose
class node_developer,node_maven toneIndigo
```

## Components

### Change calculation

- [Diff calculator](https://github.com/yangziwen/diff-check/blob/master/diff-core/src/main/java/io/github/yangziwen/diff/calculate/DiffCalculator.java): `diff-core/src/main/java/io/github/yangziwen/diff/calculate/DiffCalculator.java`
- [Diff entries](https://github.com/yangziwen/diff-check/blob/master/diff-core/src/main/java/io/github/yangziwen/diff/calculate/DiffEntryWrapper.java): `diff-core/src/main/java/io/github/yangziwen/diff/calculate/DiffEntryWrapper.java`
- [Diff helper](https://github.com/yangziwen/diff-check/blob/master/diff-core/src/main/java/io/github/yangziwen/diff/calculate/DiffHelper.java): `diff-core/src/main/java/io/github/yangziwen/diff/calculate/DiffHelper.java`
- [Merge base](https://github.com/yangziwen/diff-check/blob/master/diff-core/src/main/java/io/github/yangziwen/diff/calculate/MergeBaseCalculator.java): `diff-core/src/main/java/io/github/yangziwen/diff/calculate/MergeBaseCalculator.java`
- [Blame calculator](https://github.com/yangziwen/diff-check/blob/master/diff-core/src/main/java/io/github/yangziwen/diff/calculate/BlameCalculator.java): `diff-core/src/main/java/io/github/yangziwen/diff/calculate/BlameCalculator.java`

### Checkstyle analysis

- [Checkstyle CLI](https://github.com/yangziwen/diff-check/blob/master/diff-checkstyle/src/main/java/io/github/yangziwen/checkstyle/Main.java): `diff-checkstyle/src/main/java/io/github/yangziwen/checkstyle/Main.java`
- [Changed-line filter](https://github.com/yangziwen/diff-check/blob/master/diff-checkstyle/src/main/java/io/github/yangziwen/checkstyle/filter/DiffLineFilter.java): `diff-checkstyle/src/main/java/io/github/yangziwen/checkstyle/filter/DiffLineFilter.java`
- [Whole-diff filter](https://github.com/yangziwen/diff-check/blob/master/diff-checkstyle/src/main/java/io/github/yangziwen/checkstyle/filter/WholeDiffFilter.java): `diff-checkstyle/src/main/java/io/github/yangziwen/checkstyle/filter/WholeDiffFilter.java`

### PMD analysis

- [PMD analyzer](https://github.com/yangziwen/diff-check/blob/master/diff-pmd/src/main/java/io/github/yangziwen/pmd/Main.java): `diff-pmd/src/main/java/io/github/yangziwen/pmd/Main.java`
- [PMD CLI](https://github.com/yangziwen/diff-check/blob/master/diff-pmd/src/main/java/io/github/yangziwen/pmd/cli/PMDCommandLineInterface.java): `diff-pmd/src/main/java/io/github/yangziwen/pmd/cli/PMDCommandLineInterface.java`
- [PMD parameters](https://github.com/yangziwen/diff-check/blob/master/diff-pmd/src/main/java/io/github/yangziwen/pmd/cli/PMDParameters.java): `diff-pmd/src/main/java/io/github/yangziwen/pmd/cli/PMDParameters.java`
- [PMD configuration](https://github.com/yangziwen/diff-check/blob/master/diff-pmd/src/main/java/io/github/yangziwen/pmd/PMDConfiguration.java): `diff-pmd/src/main/java/io/github/yangziwen/pmd/PMDConfiguration.java`
- [Changed-line filter](https://github.com/yangziwen/diff-check/blob/master/diff-pmd/src/main/java/io/github/yangziwen/pmd/filter/DiffLineFilter.java): `diff-pmd/src/main/java/io/github/yangziwen/pmd/filter/DiffLineFilter.java`
- [Report renderer](https://github.com/yangziwen/diff-check/blob/master/diff-pmd/src/main/java/io/github/yangziwen/pmd/renderers/RendererFactory.java): `diff-pmd/src/main/java/io/github/yangziwen/pmd/renderers/RendererFactory.java`
- [Diff text output](https://github.com/yangziwen/diff-check/blob/master/diff-pmd/src/main/java/io/github/yangziwen/pmd/renderers/DiffTextRenderer.java): `diff-pmd/src/main/java/io/github/yangziwen/pmd/renderers/DiffTextRenderer.java`

### Coverage analysis

- [JaCoCo agent mojo](https://github.com/yangziwen/diff-check/blob/master/diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/maven/DiffAgentMojo.java): `diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/maven/DiffAgentMojo.java`
- [Changed-code filter](https://github.com/yangziwen/diff-check/blob/master/diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/filter/DiffFilter.java): `diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/filter/DiffFilter.java`
- [Author filter](https://github.com/yangziwen/diff-check/blob/master/diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/filter/PersonFilter.java): `diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/filter/PersonFilter.java`
- [Filter utilities](https://github.com/yangziwen/diff-check/blob/master/diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/util/FilterUtil.java): `diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/util/FilterUtil.java`
- [Line number wrapper](https://github.com/yangziwen/diff-check/blob/master/diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/util/LineNumberNodeWrapper.java): `diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/util/LineNumberNodeWrapper.java`
- [Collection utilities](https://github.com/yangziwen/diff-check/blob/master/diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/util/CollectionUtil.java): `diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/util/CollectionUtil.java`
- [JaCoCo filter registry](https://github.com/yangziwen/diff-check/blob/master/diff-jacoco-maven-plugin/src/main/java/org/jacoco/core/internal/analysis/filter/Filters.java): `diff-jacoco-maven-plugin/src/main/java/org/jacoco/core/internal/analysis/filter/Filters.java`
- [Report mojo](https://github.com/yangziwen/diff-check/blob/master/diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/maven/ReportMojo.java): `diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/maven/ReportMojo.java`

### Other components

- **Developer**
- **Git repository**
- **Maven run**

## Connections

- Developer → Git repository: commits changes (evidence: `README.md`)
- Developer → Checkstyle CLI: runs checks (evidence: `README.md`)
- Git repository → Diff calculator: supplies revisions (evidence: `diff-core/src/main/java/io/github/yangziwen/diff/calculate/DiffCalculator.java`)
- Diff calculator → Diff entries: produces entries (evidence: `diff-core/src/main/java/io/github/yangziwen/diff/calculate/DiffCalculator.java`)
- Diff calculator → Diff helper: uses helpers (evidence: `diff-core/src/main/java/io/github/yangziwen/diff/calculate/DiffCalculator.java`)
- Checkstyle CLI → Diff calculator: calculates changes (evidence: `diff-checkstyle/src/main/java/io/github/yangziwen/checkstyle/Main.java`)
- Checkstyle CLI → Changed-line filter: uses filter (evidence: `diff-checkstyle/src/main/java/io/github/yangziwen/checkstyle/Main.java`)
- Checkstyle CLI → Whole-diff filter: uses filter (evidence: `diff-checkstyle/src/main/java/io/github/yangziwen/checkstyle/Main.java`)
- Changed-line filter → Diff entries: reads entries (evidence: `diff-checkstyle/src/main/java/io/github/yangziwen/checkstyle/filter/DiffLineFilter.java`)
- Developer → PMD CLI: runs analysis (evidence: `README.md`)
- PMD CLI → PMD analyzer: dispatches analysis (evidence: `diff-pmd/src/main/java/io/github/yangziwen/pmd/cli/PMDCommandLineInterface.java`)
- PMD analyzer → PMD parameters: extracts options (evidence: `diff-pmd/src/main/java/io/github/yangziwen/pmd/Main.java`)
- PMD parameters → PMD configuration: configures analyzer (evidence: `diff-pmd/src/main/java/io/github/yangziwen/pmd/cli/PMDParameters.java`)
- PMD analyzer → Diff calculator: calculates changes (evidence: `diff-pmd/src/main/java/io/github/yangziwen/pmd/Main.java`)
- PMD analyzer → Changed-line filter: filters violations (evidence: `diff-pmd/src/main/java/io/github/yangziwen/pmd/Main.java`)
- Changed-line filter → Diff entries: reads entries (evidence: `diff-pmd/src/main/java/io/github/yangziwen/pmd/filter/DiffLineFilter.java`)
- PMD analyzer → Report renderer: selects renderer (evidence: `diff-pmd/src/main/java/io/github/yangziwen/pmd/Main.java`)
- Report renderer → Diff text output: creates renderer (evidence: `diff-pmd/src/main/java/io/github/yangziwen/pmd/renderers/RendererFactory.java`)
- Maven run → JaCoCo agent mojo: starts coverage (evidence: `README.md`)
- JaCoCo agent mojo → Diff calculator: calculates changes (evidence: `diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/maven/DiffAgentMojo.java`)
- JaCoCo agent mojo → Merge base: resolves comparison (evidence: `diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/maven/DiffAgentMojo.java`)
- JaCoCo agent mojo → Blame calculator: gets authorship (evidence: `diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/maven/DiffAgentMojo.java`)
- JaCoCo agent mojo → Changed-code filter: registers filter (evidence: `diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/maven/DiffAgentMojo.java`)
- JaCoCo agent mojo → Author filter: registers filter (evidence: `diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/maven/DiffAgentMojo.java`)
- JaCoCo agent mojo → Filter utilities: appends filters (evidence: `diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/maven/DiffAgentMojo.java`)
- Changed-code filter → Filter utilities: uses utilities (evidence: `diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/filter/DiffFilter.java`)
- Author filter → Filter utilities: uses utilities (evidence: `diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/filter/PersonFilter.java`)
- Filter utilities → JaCoCo filter registry: registers filter (evidence: `diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/util/FilterUtil.java`)
- Filter utilities → Line number wrapper: wraps line nodes (evidence: `diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/util/FilterUtil.java`)
- Filter utilities → Collection utilities: checks collections (evidence: `diff-jacoco-maven-plugin/src/main/java/io/github/yangziwen/jacoco/util/FilterUtil.java`)
- Maven run → Report mojo: requests report (evidence: `README.md`)
