# analysis-tools-dev/static-analysis architecture

> Architecture diagram of the GitHub repository analysis-tools-dev/static-analysis, 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/analysis-tools-dev/static-analysis
- Repository: https://github.com/analysis-tools-dev/static-analysis

## Overview

This repository is the source catalog for analysis-tools.dev: it curates static-analysis tools and provides rendering and API data, alongside a pull-request eligibility checker. The principal contributor workflow checks changed tool YAML, retrieves repository or domain metadata, evaluates contribution criteria, and produces a report. The catalog also organizes tools by language and other tags, supports collections and statistics, and marks deprecated tools. The graph draws on the README and sampled Rust sources; unsampled renderer details are represented only at their supported directory level.

Main entry points: [`ci/crates/render/src/lib.rs`](https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/render/src/lib.rs) (Catalog normalization), [`ci/crates/pr-check/src/main.rs`](https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/pr-check/src/main.rs) (PR checker), [`ci/crates/pr-check/src/network.rs`](https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/pr-check/src/network.rs) (Metadata retrieval), [`ci/crates/pr-check/src/criteria.rs`](https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/pr-check/src/criteria.rs) (Eligibility criteria)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_catalog["Catalog Data"]
  node_tool_entries[("Tool entries")]
  node_tag_definitions["Tag definitions<br/>[tags.yml]"]
  node_collections[("Collections")]
  node_api_data[("API data")]
  node_stats_data[("API statistics")]
end

subgraph group_render["Catalog Rendering"]
  node_render_cli["Catalog renderer<br/>[main.rs]"]
  node_render_core["Catalog normalization<br/>[lib.rs]"]
  node_entry_types["Entry types<br/>[types.rs]"]
  node_validated_values["Validated values<br/>[validated.rs]"]
  node_deprecation["Deprecation checks<br/>[deprecation.rs]"]
  node_stats_parser["Statistics parser<br/>[stats.rs]"]
end

subgraph group_review["Contribution Review"]
  node_pr_cli["PR checker<br/>[main.rs]"]
  node_tool_input["Tool input loader<br/>[input.rs]"]
  node_network_checks["Metadata retrieval<br/>[network.rs]"]
  node_criteria["Eligibility criteria<br/>[criteria.rs]"]
  node_check_rules["Check rules<br/>[checks.rs]"]
  node_reports["Review reports<br/>[report.rs]"]
end

subgraph group_integrations["External Services"]
  node_github(("GitHub"))
  node_repo_client["Repository types<br/>[lib.rs]"]
end

node_contributors(("Catalog contributors"))
node_website(("Analysis Tools website"))
node_pr_author(("Pull request author"))

node_contributors -->|"contribute entries"| node_tool_entries
node_tool_entries -.->|"render catalog"| node_render_cli
node_tag_definitions -.->|"classifies entries"| node_render_core
node_collections -.->|"renders collections"| node_render_core
node_stats_data -.->|"provides statistics"| node_stats_parser
node_render_cli -.->|"invokes rendering"| node_render_core
node_render_core -->|"uses types"| node_entry_types
node_render_core -->|"uses deprecation"| node_deprecation
node_render_core -->|"formats statistics"| node_stats_parser
node_entry_types -->|"uses validation"| node_validated_values
node_render_core -.->|"creates API data"| node_api_data
node_render_core -.->|"supplies catalog"| node_website
node_pr_author -->|"submits changes"| node_pr_cli
node_tool_entries -->|"loads changed YAML"| node_tool_input
node_pr_cli -->|"loads entries"| node_tool_input
node_pr_cli -->|"checks tools"| node_network_checks
node_network_checks -->|"fetches metadata"| node_github
node_network_checks -->|"uses repository types"| node_repo_client
node_network_checks -->|"builds reports"| node_criteria
node_criteria -->|"evaluates checks"| node_check_rules
node_criteria -->|"reads tool fields"| node_tool_input
node_criteria -->|"creates outcomes"| node_reports
node_pr_cli -->|"renders report"| node_reports

click node_tool_entries "https://github.com/analysis-tools-dev/static-analysis/tree/master/data/tools"
click node_tag_definitions "https://github.com/analysis-tools-dev/static-analysis/blob/master/data/tags.yml"
click node_collections "https://github.com/analysis-tools-dev/static-analysis/tree/master/data/collections"
click node_api_data "https://github.com/analysis-tools-dev/static-analysis/tree/master/data/api"
click node_stats_data "https://github.com/analysis-tools-dev/static-analysis/tree/master/data/api/stats"
click node_render_cli "https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/render/src/bin/main.rs"
click node_render_core "https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/render/src/lib.rs"
click node_entry_types "https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/render/src/types.rs"
click node_validated_values "https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/render/src/validated.rs"
click node_deprecation "https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/render/src/deprecation.rs"
click node_stats_parser "https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/render/src/stats.rs"
click node_pr_cli "https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/pr-check/src/main.rs"
click node_tool_input "https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/pr-check/src/input.rs"
click node_network_checks "https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/pr-check/src/network.rs"
click node_criteria "https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/pr-check/src/criteria.rs"
click node_check_rules "https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/pr-check/src/checks.rs"
click node_reports "https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/pr-check/src/report.rs"
click node_repo_client "https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/github-repo/src/lib.rs"

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_tool_entries,node_tag_definitions,node_collections,node_api_data,node_stats_data toneBlue
class node_render_cli,node_render_core,node_entry_types,node_validated_values,node_deprecation,node_stats_parser toneAmber
class node_pr_cli,node_tool_input,node_network_checks,node_criteria,node_check_rules,node_reports,node_pr_author toneMint
class node_github,node_repo_client toneRose
class node_contributors,node_website toneIndigo
```

## Components

### Catalog Data

- [Tool entries](https://github.com/analysis-tools-dev/static-analysis/tree/master/data/tools): `data/tools`
- [Tag definitions](https://github.com/analysis-tools-dev/static-analysis/blob/master/data/tags.yml): `data/tags.yml`
- [Collections](https://github.com/analysis-tools-dev/static-analysis/tree/master/data/collections): `data/collections`
- [API data](https://github.com/analysis-tools-dev/static-analysis/tree/master/data/api): `data/api`
- [API statistics](https://github.com/analysis-tools-dev/static-analysis/tree/master/data/api/stats): `data/api/stats`

### Catalog Rendering

- [Catalog renderer](https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/render/src/bin/main.rs): `ci/crates/render/src/bin/main.rs`
- [Catalog normalization](https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/render/src/lib.rs): `ci/crates/render/src/lib.rs`
- [Entry types](https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/render/src/types.rs): `ci/crates/render/src/types.rs`
- [Validated values](https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/render/src/validated.rs): `ci/crates/render/src/validated.rs`
- [Deprecation checks](https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/render/src/deprecation.rs): `ci/crates/render/src/deprecation.rs`
- [Statistics parser](https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/render/src/stats.rs): `ci/crates/render/src/stats.rs`

### Contribution Review

- [PR checker](https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/pr-check/src/main.rs): `ci/crates/pr-check/src/main.rs`
- [Tool input loader](https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/pr-check/src/input.rs): `ci/crates/pr-check/src/input.rs`
- [Metadata retrieval](https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/pr-check/src/network.rs): `ci/crates/pr-check/src/network.rs`
- [Eligibility criteria](https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/pr-check/src/criteria.rs): `ci/crates/pr-check/src/criteria.rs`
- [Check rules](https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/pr-check/src/checks.rs): `ci/crates/pr-check/src/checks.rs`
- [Review reports](https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/pr-check/src/report.rs): `ci/crates/pr-check/src/report.rs`

### External Services

- **GitHub**
- [Repository types](https://github.com/analysis-tools-dev/static-analysis/blob/master/ci/crates/github-repo/src/lib.rs): `ci/crates/github-repo/src/lib.rs`

### Other components

- **Catalog contributors**
- **Analysis Tools website**
- **Pull request author**

## Connections

- Catalog contributors → Tool entries: contribute entries (evidence: `README.md`)
- Tool entries → Catalog renderer: render catalog
- Tag definitions → Catalog normalization: classifies entries
- Collections → Catalog normalization: renders collections
- API statistics → Statistics parser: provides statistics
- Catalog renderer → Catalog normalization: invokes rendering
- Catalog normalization → Entry types: uses types (evidence: `ci/crates/render/src/lib.rs`)
- Catalog normalization → Deprecation checks: uses deprecation (evidence: `ci/crates/render/src/lib.rs`)
- Catalog normalization → Statistics parser: formats statistics (evidence: `ci/crates/render/src/lib.rs`)
- Entry types → Validated values: uses validation (evidence: `ci/crates/render/src/types.rs`)
- Catalog normalization → API data: creates API data
- Catalog normalization → Analysis Tools website: supplies catalog (evidence: `README.md`)
- Pull request author → PR checker: submits changes (evidence: `ci/crates/pr-check/src/main.rs`)
- Tool entries → Tool input loader: loads changed YAML
- PR checker → Tool input loader: loads entries (evidence: `ci/crates/pr-check/src/main.rs`)
- PR checker → Metadata retrieval: checks tools (evidence: `ci/crates/pr-check/src/main.rs`)
- Metadata retrieval → GitHub: fetches metadata (evidence: `ci/crates/pr-check/src/network.rs`)
- Metadata retrieval → Repository types: uses repository types (evidence: `ci/crates/pr-check/src/network.rs`)
- Metadata retrieval → Eligibility criteria: builds reports (evidence: `ci/crates/pr-check/src/network.rs`)
- Eligibility criteria → Check rules: evaluates checks (evidence: `ci/crates/pr-check/src/criteria.rs`)
- Eligibility criteria → Tool input loader: reads tool fields (evidence: `ci/crates/pr-check/src/criteria.rs`)
- Eligibility criteria → Review reports: creates outcomes (evidence: `ci/crates/pr-check/src/criteria.rs`)
- PR checker → Review reports: renders report (evidence: `ci/crates/pr-check/src/main.rs`)
