# i-rzr-i/codesource architecture

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

- Interactive diagram: https://gitdiagram.com/i-rzr-i/codesource
- Repository: https://github.com/i-rzr-i/codesource

## Overview

CodeSource is a .NET library for recording code-attribution metadata in attributes, reflecting over compiled assemblies to collect it, and exporting the resulting report. The principal workflow is annotate code, scan an assembly (optionally including its direct references), then select an export format. Scanning builds hierarchical type/member history and can report stage-specific errors; exporters produce six documented formats. Relationships for unsampled implementation details are limited to dependencies visible in the source index or the README.

Main entry points: [`src/CodeSource/Helpers/CodeSourceHelper.cs`](https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Helpers/CodeSourceHelper.cs) (Reflection scan), [`src/CodeSource/Services/Export`](https://github.com/i-rzr-i/codesource/tree/main/src/CodeSource/Services/Export) (Format exporters), [`src/CodeSource/Services/CodeSourceScanner.cs`](https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Services/CodeSourceScanner.cs) (Scanner service), [`src/CodeSource/Services/ExporterRegistry.cs`](https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Services/ExporterRegistry.cs) (Exporter registry)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_annotation["Attribution metadata"]
  node_attribute["CodeSource attribute"]
  node_attribute_contract["Attribute contract"]
end

subgraph group_scanning["Assembly scanning"]
  node_scanner["Scanner service"]
  node_scan_helper["Reflection scan"]
  node_scan_options["Scan options"]
  node_scan_failures["Scan errors"]
  node_scan_stages["Scan stages"]
  node_report_result["Scan result"]
  node_code_object["Code object"]
  node_history["Attribution history"]
end

subgraph group_reporting["Report export"]
  node_export_registry["Exporter registry"]
  node_format_constants["Format constants<br/>[ExportFormats.cs]"]
  node_export_contract["Exporter contract"]
  node_exporters["Format exporters"]
  node_export_error["Export errors"]
end

node_developer(("Library user"))
node_assembly["Annotated assemblies"]
node_output_stream["Report output"]

node_developer -->|"annotates code"| node_attribute
node_attribute -->|"implements"| node_attribute_contract
node_developer -->|"requests scan"| node_scanner
node_assembly -->|"provides assembly"| node_scanner
node_scanner -->|"delegates scan"| node_scan_helper
node_scanner -->|"uses options"| node_scan_options
node_scan_helper -->|"reads annotations"| node_attribute
node_scan_helper -->|"uses options"| node_scan_options
node_scan_helper -->|"reports failures"| node_scan_failures
node_scan_helper -->|"records stage"| node_scan_stages
node_scan_helper -->|"builds results"| node_report_result
node_report_result -->|"contains objects"| node_code_object
node_code_object -->|"holds history"| node_history
node_developer -->|"selects format"| node_export_registry
node_scanner -->|"supplies results"| node_export_registry
node_export_registry -->|"selects format"| node_format_constants
node_export_registry -->|"dispatches through"| node_export_contract
node_export_registry -->|"dispatches to"| node_exporters
node_exporters -->|"serializes results"| node_report_result
node_exporters -->|"serializes history"| node_history
node_exporters -->|"wraps failures"| node_export_error
node_exporters -->|"writes report"| node_output_stream

click node_attribute "https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/CodeSourceAttribute.cs"
click node_attribute_contract "https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Abstractions/ICodeSourceAttribute.cs"
click node_scanner "https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Services/CodeSourceScanner.cs"
click node_scan_helper "https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Helpers/CodeSourceHelper.cs"
click node_scan_options "https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Models/CodeSourceScanOptions.cs"
click node_scan_failures "https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Models/CodeSourceScanError.cs"
click node_scan_stages "https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Models/CodeSourceScanStage.cs"
click node_report_result "https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Models/CodeSourceObjectsResult.cs"
click node_code_object "https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Models/CodeSourceObject.cs"
click node_history "https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Models/CodeSourceObjectHistory.cs"
click node_export_registry "https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Services/ExporterRegistry.cs"
click node_format_constants "https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/ExportFormats.cs"
click node_export_contract "https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Abstractions/ICodeSourceExporter.cs"
click node_exporters "https://github.com/i-rzr-i/codesource/tree/main/src/CodeSource/Services/Export"
click node_export_error "https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Exceptions/CodeSourceExporterException.cs"

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_attribute,node_attribute_contract,node_developer toneBlue
class node_scanner,node_scan_helper,node_scan_options,node_scan_failures,node_scan_stages,node_report_result,node_code_object,node_history toneAmber
class node_export_registry,node_format_constants,node_export_contract,node_exporters,node_export_error toneMint
class node_assembly,node_output_stream toneIndigo
```

## Components

### Attribution metadata

- [CodeSource attribute](https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/CodeSourceAttribute.cs): `src/CodeSource/CodeSourceAttribute.cs`
- [Attribute contract](https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Abstractions/ICodeSourceAttribute.cs): `src/CodeSource/Abstractions/ICodeSourceAttribute.cs`

### Assembly scanning

- [Scanner service](https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Services/CodeSourceScanner.cs): `src/CodeSource/Services/CodeSourceScanner.cs`
- [Reflection scan](https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Helpers/CodeSourceHelper.cs): `src/CodeSource/Helpers/CodeSourceHelper.cs`
- [Scan options](https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Models/CodeSourceScanOptions.cs): `src/CodeSource/Models/CodeSourceScanOptions.cs`
- [Scan errors](https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Models/CodeSourceScanError.cs): `src/CodeSource/Models/CodeSourceScanError.cs`
- [Scan stages](https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Models/CodeSourceScanStage.cs): `src/CodeSource/Models/CodeSourceScanStage.cs`
- [Scan result](https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Models/CodeSourceObjectsResult.cs): `src/CodeSource/Models/CodeSourceObjectsResult.cs`
- [Code object](https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Models/CodeSourceObject.cs): `src/CodeSource/Models/CodeSourceObject.cs`
- [Attribution history](https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Models/CodeSourceObjectHistory.cs): `src/CodeSource/Models/CodeSourceObjectHistory.cs`

### Report export

- [Exporter registry](https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Services/ExporterRegistry.cs): `src/CodeSource/Services/ExporterRegistry.cs`
- [Format constants](https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/ExportFormats.cs): `src/CodeSource/ExportFormats.cs`
- [Exporter contract](https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Abstractions/ICodeSourceExporter.cs): `src/CodeSource/Abstractions/ICodeSourceExporter.cs`
- [Format exporters](https://github.com/i-rzr-i/codesource/tree/main/src/CodeSource/Services/Export): `src/CodeSource/Services/Export`
- [Export errors](https://github.com/i-rzr-i/codesource/blob/main/src/CodeSource/Exceptions/CodeSourceExporterException.cs): `src/CodeSource/Exceptions/CodeSourceExporterException.cs`

### Other components

- **Library user**
- **Annotated assemblies**
- **Report output**

## Connections

- Library user → CodeSource attribute: annotates code (evidence: `README.md`)
- CodeSource attribute → Attribute contract: implements (evidence: `src/CodeSource/CodeSourceAttribute.cs`)
- Library user → Scanner service: requests scan (evidence: `README.md`)
- Annotated assemblies → Scanner service: provides assembly (evidence: `README.md`)
- Scanner service → Reflection scan: delegates scan (evidence: `src/CodeSource/Services/CodeSourceScanner.cs`)
- Scanner service → Scan options: uses options (evidence: `src/CodeSource/Services/CodeSourceScanner.cs`)
- Reflection scan → CodeSource attribute: reads annotations (evidence: `src/CodeSource/Helpers/CodeSourceHelper.cs`)
- Reflection scan → Scan options: uses options (evidence: `src/CodeSource/Helpers/CodeSourceHelper.cs`)
- Reflection scan → Scan errors: reports failures (evidence: `src/CodeSource/Helpers/CodeSourceHelper.cs`)
- Reflection scan → Scan stages: records stage (evidence: `src/CodeSource/Helpers/CodeSourceHelper.cs`)
- Reflection scan → Scan result: builds results (evidence: `src/CodeSource/Helpers/CodeSourceHelper.cs`)
- Scan result → Code object: contains objects (evidence: `src/CodeSource/Models/CodeSourceObjectsResult.cs`)
- Code object → Attribution history: holds history (evidence: `src/CodeSource/Models/CodeSourceObject.cs`)
- Library user → Exporter registry: selects format (evidence: `README.md`)
- Scanner service → Exporter registry: supplies results (evidence: `README.md`)
- Exporter registry → Format constants: selects format (evidence: `src/CodeSource/ExportFormats.cs`)
- Exporter registry → Exporter contract: dispatches through (evidence: `src/CodeSource/Services/ExporterRegistry.cs`)
- Exporter registry → Format exporters: dispatches to (evidence: `src/CodeSource/Services/ExporterRegistry.cs`)
- Format exporters → Scan result: serializes results (evidence: `src/CodeSource/Services/Export/JsonExporter.cs`)
- Format exporters → Attribution history: serializes history (evidence: `src/CodeSource/Services/Export/JsonExporter.cs`)
- Format exporters → Export errors: wraps failures (evidence: `src/CodeSource/Services/Export/JsonExporter.cs`)
- Format exporters → Report output: writes report (evidence: `README.md`)
