# fri-day/sonar-gosu-plugin architecture

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

- Interactive diagram: https://gitdiagram.com/fri-day/sonar-gosu-plugin
- Repository: https://github.com/fri-day/sonar-gosu-plugin

## Overview

- Source Files -> Parser -> AST -> Rules Analysis -> SonarQube Issues

- Configuration Flow
- Metrics Collection Flow
- Report Generation Flow

##### Integration Points (Purple Diamonds)
- SonarQube API Integration
- ANTLR4 Integration
- Test Framework Integration

##### Key Subsystems

a. Measures Subsystem
- Code Metrics
- Complexity Calculations
- Test Coverage

b. Issues Subsystem
- Issue Collection
- Issue Reporting
- Suppression Handling

##### External Dependencies (Gray Rectangles)
- SonarQube Server
- ANTLR4 Runtime
- Gradle Build System

##### The plugin's architecture as a SonarQube extension
- Clear boundaries between plugin code and SonarQube platform
- Extension points (Sensor, Rules, Metrics)

##### The parsing pipeline
- Source Files -> ANTLR4 Lexer -> Tokens -> ANTLR4 Parser -> AST -> Rule Visitors

##### Rules organization
- Rules by category (bugs, vulnerabilities, code smells)
- Relationship to quality profiles

##### Metrics collection
- Code size metrics
- Complexity metrics
- Test metrics

Keep the abstraction level appropriate by:
- Focusing on major components rather than individual classes
- Showing primary data flows and interactions
- Highlighting extension points and integration boundaries
- Including key technical decisions (e.g., ANTLR4 usage)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Core Plugin Components
    subgraph Core
        GP["GosuPlugin"]:::core
        GL["GosuLanguage"]:::core
        GRD["GosuRulesDefinition"]:::core
        GQP["GosuQualityProfile"]:::core
    end

    %% Parser Components
    subgraph Parser
        ANTLR["ANTLR4 Grammar"]:::parser
        GFP["GosuFileParser"]:::parser
        PCH["Parser Context Handlers"]:::parser
    end

    %% Analysis Components
    subgraph Analysis
        RE["Rules Engine"]:::analysis
        MC["Metrics Collection"]:::analysis
        IR["Issue Reporting"]:::analysis
    end

    %% Rules Implementation
    subgraph Rules
        BR["Bugs Rules"]:::rules
        CSR["Code Smells Rules"]:::rules
        VR["Vulnerability Rules"]:::rules
        MR["Metrics Rules"]:::rules
    end

    %% Measures Subsystem
    subgraph Measures
        CM["Code Metrics"]:::measures
        CC["Complexity Calculations"]:::measures
        TC["Test Coverage"]:::measures
    end

    %% Integration Points
    SQI[("SonarQube API")]:::integration
    A4I[("ANTLR4")]:::integration
    TFI[("Test Framework")]:::integration

    %% External Dependencies
    SQS["SonarQube Server"]:::external
    A4R["ANTLR4 Runtime"]:::external
    GBS["Gradle Build System"]:::external

    %% Relationships
    SQS --> SQI
    A4R --> A4I
    GBS --> Core

    Core --> Parser
    Parser --> Analysis
    Analysis --> Rules
    Rules --> Measures
    
    A4I --> ANTLR
    SQI --> GP
    TFI --> TC

    %% Click Events
    click GP "https://github.com/FRI-DAY/sonar-gosu-plugin/blob/main/src/main/java/de/friday/sonarqube/gosu/GosuPlugin.java"
    click GL "https://github.com/FRI-DAY/sonar-gosu-plugin/blob/main/src/main/java/de/friday/sonarqube/gosu/language/GosuLanguage.java"
    click GRD "https://github.com/FRI-DAY/sonar-gosu-plugin/blob/main/src/main/java/de/friday/sonarqube/gosu/plugin/GosuRulesDefinition.java"
    click GQP "https://github.com/FRI-DAY/sonar-gosu-plugin/blob/main/src/main/java/de/friday/sonarqube/gosu/plugin/GosuQualityProfile.java"
    click ANTLR "https://github.com/FRI-DAY/sonar-gosu-plugin/tree/main/src/main/antlr"
    click GFP "https://github.com/FRI-DAY/sonar-gosu-plugin/blob/main/src/main/java/de/friday/sonarqube/gosu/plugin/GosuFileParser.java"
    click PCH "https://github.com/FRI-DAY/sonar-gosu-plugin/blob/main/src/main/java/de/friday/sonarqube/gosu/plugin/context/GosuParserContext.java"
    click RE "https://github.com/FRI-DAY/sonar-gosu-plugin/blob/main/src/main/java/de/friday/sonarqube/gosu/plugin/rules/BaseGosuRule.java"
    click MC "https://github.com/FRI-DAY/sonar-gosu-plugin/blob/main/src/main/java/de/friday/sonarqube/gosu/plugin/measures/Measures.java"
    click IR "https://github.com/FRI-DAY/sonar-gosu-plugin/blob/main/src/main/java/de/friday/sonarqube/gosu/plugin/issues/IssueCollector.java"
    click BR "https://github.com/FRI-DAY/sonar-gosu-plugin/tree/main/src/main/java/de/friday/sonarqube/gosu/plugin/rules/bugs"
    click CSR "https://github.com/FRI-DAY/sonar-gosu-plugin/tree/main/src/main/java/de/friday/sonarqube/gosu/plugin/rules/smells"
    click VR "https://github.com/FRI-DAY/sonar-gosu-plugin/tree/main/src/main/java/de/friday/sonarqube/gosu/plugin/rules/vulnerabilities"
    click MR "https://github.com/FRI-DAY/sonar-gosu-plugin/tree/main/src/main/java/de/friday/sonarqube/gosu/plugin/rules/metrics"
    click CM "https://github.com/FRI-DAY/sonar-gosu-plugin/blob/main/src/main/java/de/friday/sonarqube/gosu/plugin/measures/metrics/CodeSizeMetrics.java"
    click CC "https://github.com/FRI-DAY/sonar-gosu-plugin/blob/main/src/main/java/de/friday/sonarqube/gosu/plugin/measures/metrics/CognitiveComplexityMetric.java"
    click TC "https://github.com/FRI-DAY/sonar-gosu-plugin/blob/main/src/main/java/de/friday/sonarqube/gosu/plugin/measures/metrics/TestsMetric.java"

    %% Styles
    classDef core fill:#2196F3,stroke:#1565C0,color:white
    classDef parser fill:#4CAF50,stroke:#2E7D32,color:white
    classDef analysis fill:#FFC107,stroke:#FFA000,color:black
    classDef rules fill:#FF9800,stroke:#F57C00,color:white
    classDef measures fill:#9C27B0,stroke:#7B1FA2,color:white
    classDef integration fill:#E91E63,stroke:#C2185B,color:white
    classDef external fill:#9E9E9E,stroke:#616161,color:white

    %% Legend
    subgraph Legend
        L1["Core Components"]:::core
        L2["Parser Components"]:::parser
        L3["Analysis Components"]:::analysis
        L4["Rules Components"]:::rules
        L5["Measures Components"]:::measures
        L6[("Integration Points")]:::integration
        L7["External Dependencies"]:::external
    end
```
