mirror of
https://github.com/tiennm99/ghstats.git
synced 2026-08-31 18:31:11 +00:00
tiennm99
8b3a8e1932
Seven canonical docs under docs/ per the project structure convention: - project-overview-pdr.md users, non-goals, requirements - codebase-summary.md directory layout, module responsibilities - system-architecture.md runtime phases, GraphQL flow, SVG primitives - code-standards.md YAGNI/KISS/DRY, Go conventions, commit rules - design-guidelines.md frame dimensions, theme roles, per-card specs - deployment-guide.md Action/binary/Docker paths, release process - project-roadmap.md done phases (0-5), planned phases (6-9) All files under the 800-line cap. Each leans on tables; grammar sacrificed for concision per project rules.
110 lines
5.5 KiB
Markdown
110 lines
5.5 KiB
Markdown
# Codebase Summary
|
||
|
||
## Layout
|
||
|
||
```
|
||
ghstats/
|
||
├── main.go # CLI entry point; wires flags → fetchers → renderers
|
||
├── action.yml # GitHub Action metadata
|
||
├── entrypoint.sh # Action runtime; maps INPUT_* env → CLI flags
|
||
├── Dockerfile # Multi-stage build for the Action image
|
||
├── go.mod # Module declaration; no external deps
|
||
├── internal/
|
||
│ ├── github/ # GraphQL client + fetchers + models
|
||
│ │ ├── client.go # HTTP POST to /graphql, error decoding
|
||
│ │ ├── queries.go # profileQuery, commitHistoryQuery, contributionYearQuery
|
||
│ │ ├── model.go # Profile, RepoInfo, LangStat, LangEdge, DailyContribution
|
||
│ │ ├── profile.go # FetchProfile — user + owned repos + stats + calendar
|
||
│ │ ├── productive.go # FetchProductive — commit history → hour histogram + lang buckets
|
||
│ │ ├── contributions_all_time.go # FetchContributionsAllTime — per-year loop → seed list + daily series
|
||
│ │ └── profile_test.go # sortLangStats tiebreak
|
||
│ ├── card/ # SVG renderers; one file per card
|
||
│ │ ├── card.go # Card interface, RenderAll, allCards slice
|
||
│ │ ├── svg.go # escapeXML, formatInt, header, footer
|
||
│ │ ├── axis.go # niceTicks (d3-style 1/2/5 × 10^k), formatTick
|
||
│ │ ├── icons.go # Octicon path strings
|
||
│ │ ├── profile.go # 0-profile-details
|
||
│ │ ├── repos_per_language.go # 1-repos-per-language
|
||
│ │ ├── most_commit_language.go # 2-most-commit-language
|
||
│ │ ├── most_commit_language_all_time.go # 6-most-commit-language-all-time
|
||
│ │ ├── stats.go # 3-stats
|
||
│ │ ├── productive.go # 4-productive-time + 7-*-all-time
|
||
│ │ ├── contributions.go # 5-contributions + 8-*-all-time
|
||
│ │ ├── donut_chart.go # renderDonutCard — shared by language cards
|
||
│ │ └── card_test.go # Rendering + escape + format tests
|
||
│ └── theme/
|
||
│ └── theme.go # 61-palette map ported from github-profile-summary-cards
|
||
├── .github/workflows/
|
||
│ ├── ci.yml # go vet + go test on push/PR
|
||
│ └── release.yml # GHCR image + cross-platform binaries on tag
|
||
├── docs/ # This directory
|
||
├── plans/ # Research reports + implementation plans
|
||
└── output/dracula/ # Sample committed; other themes gitignored
|
||
```
|
||
|
||
## Module responsibilities
|
||
|
||
### `internal/github`
|
||
|
||
All network I/O. Exposes a `*Client` with three fetchers:
|
||
|
||
| Fetcher | Input | Populates |
|
||
| --- | --- | --- |
|
||
| `FetchProfile(login, opts)` | username, visibility flags | Profile basics, totals, owned-repos aggregation, last-year daily calendar, `TopRepos` |
|
||
| `FetchContributionsAllTime(p, opts)` | Profile | `SeedRepos`, `DailyContributionsAllTime`, `TotalCommitsAllTime` |
|
||
| `FetchProductive(p, repos, loc, cap)` | Profile + seed + tz + cap | `Productive`, `CommitsByLanguage`, `ProductiveAllTime`, `CommitsByLanguageAllTime` |
|
||
|
||
Call order in `main.go`: Profile → AllTime → Productive.
|
||
|
||
### `internal/card`
|
||
|
||
Pure rendering. Every card implements the `Card` interface:
|
||
|
||
```go
|
||
type Card interface {
|
||
Filename() string
|
||
SVG(*github.Profile, theme.Theme) ([]byte, error)
|
||
}
|
||
```
|
||
|
||
`RenderAll` iterates `allCards`, writes each to `<outDir>/<themeID>/<Filename>`.
|
||
|
||
Shared helpers:
|
||
- `renderDonutCard` — language donut + legend (used by 3 language cards)
|
||
- `renderProductiveTime` — 24h bar chart (used by both productive cards)
|
||
- `renderContributions` — smooth area chart (used by both contributions cards)
|
||
- `header`, `footer` — SVG chrome
|
||
- `niceTicks`, `formatTick` — axis math
|
||
|
||
### `internal/theme`
|
||
|
||
Static map of 61 themes. Each theme specifies title/text/background/stroke/accent/muted plus `StrokeOpacity` for correct light-theme borders.
|
||
|
||
## Card ↔ data flow
|
||
|
||
```
|
||
profileQuery ─────► Profile.{identity, owned repos, totals, last-year calendar}
|
||
│
|
||
contributionYearQuery ─┬──► SeedRepos + DailyContributionsAllTime + TotalCommitsAllTime
|
||
│
|
||
└─ seed into ─►
|
||
│
|
||
commitHistoryQuery ──► Productive + CommitsByLanguage (+ AllTime variants)
|
||
│
|
||
▼
|
||
9 SVG files per theme
|
||
```
|
||
|
||
## Test coverage
|
||
|
||
- `internal/card/card_test.go` — RenderAll produces 9 valid SVGs; escape + formatInt spot-checks.
|
||
- `internal/github/profile_test.go` — `sortLangStats` ordering and tiebreak.
|
||
|
||
No network-touching tests; real runs verified via `-token` + local build.
|
||
|
||
## Naming conventions
|
||
|
||
- Go files use snake_case for multi-word names (`repos_per_language.go`, `contributions_all_time.go`).
|
||
- Cards' `Filename()` returns the numbered SVG output name — consumers sort lexicographically.
|
||
- Themes in snake_case to match upstream (`github_dark`, `nord_bright`).
|