How chefmarvin/roux works
Roux turns Git history or a supplied log into structured modification records, applies optional path/team/time transforms, runs a selected analysis, and emits CSV or JSON. The CLI and public API initiate the same application workflow. The README documents a broad analysis suite; the graph groups those analyses by purpose rather than listing every individual analysis. Edges reflect the sampled application flow and SOURCE INDEX references; unsampled implementation details are not inferred.
Main entry points: index.ts Analysis selection · app.ts Analysis workflow · dataset.ts Dataset helpers · git.ts Git log generator
Components 27
Entry points
- CLI
src/cli.ts - Analysis workflow
src/app.ts
History input
- Git history
- Git log generator
src/git.ts - Log cache
src/cache.ts - Parser registry
src/parsers/index.ts - Git parser
src/parsers/git.ts - Git2 parser
src/parsers/git2.ts - Rename path parser
src/parsers/rename.ts - Modification records
src/parsers/types.ts
Data transforms
- Rename tracking
src/transforms/rename-tracker.ts - Architectural grouping
src/transforms/grouper.ts - Temporal grouping
src/transforms/temporal-grouper.ts - Team mapping
src/transforms/team-mapper.ts
Analysis
- Analysis selection
src/analysis/index.ts - Hotspot and churn
src/analysis/churn.ts - Coupling
src/analysis/coupling.ts - Age
src/analysis/age.ts - Collaboration
src/analysis/communication.ts - Knowledge fragmentation
src/analysis/fragmentation.ts - Ownership and effort
src/analysis - Other analyses
src/analysis - Dataset helpers
src/utils/dataset.ts
Output
- CSV formatter
src/output/csv.ts - JSON formatter
src/output/json.ts
Other components
- CLI user
- API caller
Connections 33
- CLI user → CLI: invokes
src/cli.ts - CLI → Analysis workflow: calls
src/cli.ts - API caller → Analysis workflow: calls
- Analysis workflow → Git log generator: generates log
src/app.ts - Git log generator → Git history: queries
src/git.ts - Git log generator → Log cache: checks cache
src/git.ts - Log cache → Git history: queries commits
src/cache.ts - Analysis workflow → Parser registry: selects parser
src/app.ts - Parser registry → Git parser: registers
src/parsers/index.ts - Parser registry → Git2 parser: registers
src/parsers/index.ts - Git parser → Rename path parser: parses renames
src/parsers/git.ts - Git2 parser → Rename path parser: parses renames
src/parsers/git2.ts - Git parser → Modification records: creates records
src/parsers/git.ts - Git2 parser → Modification records: creates records
src/parsers/git2.ts - Analysis workflow → Rename tracking: tracks renames
src/app.ts - Analysis workflow → Architectural grouping: applies groups
src/app.ts - Analysis workflow → Temporal grouping: applies periods
src/app.ts - Analysis workflow → Team mapping: maps teams
src/app.ts - Analysis workflow → Analysis selection: selects analysis
src/app.ts - Analysis selection → Hotspot and churn: registers
src/analysis/index.ts - Analysis selection → Coupling: registers
src/analysis/index.ts - Analysis selection → Age: registers
src/analysis/index.ts - Analysis selection → Collaboration: registers
src/analysis/index.ts - Analysis selection → Knowledge fragmentation: registers
src/analysis/index.ts - Analysis selection → Ownership and effort: registers
src/analysis/index.ts - Analysis selection → Other analyses: registers
src/analysis/index.ts - Hotspot and churn → Dataset helpers: uses
src/analysis/churn.ts - Coupling → Dataset helpers: uses
src/analysis/coupling.ts - Age → Dataset helpers: uses
src/analysis/age.ts - Collaboration → Dataset helpers: uses
src/analysis/communication.ts - Knowledge fragmentation → Dataset helpers: uses
src/analysis/fragmentation.ts - Analysis selection → CSV formatter: formats results
src/app.ts - Analysis selection → JSON formatter: formats results
src/app.ts