How molson82/adventofcode works
Main Components
a. Core Structure:
• Year-based Solution Modules (2019-2024)
• Shared Package Components (pkg/)
• Test Infrastructure
• Utility Scripts
b. Package Components:
• Models Package
• Utils Package
• Input Processing System
• Solution Runner
┌─ Project Core ─────────────────────────────────────────┐
• ┌─ Solution Modules ─┐ ┌─ Shared Components ───────┐ │
• 2019/ │ │ pkg/ │ │
• 2020/ │ │ ├─ models/ │ │
• 2021/ │ │ │ └─ set.go │ │
• 2022/ │ │ └─ utils/ │ │
• 2023/ │ │ ├─ err.go │ │
• 2024/ │ │ ├─ input.go │ │
• Each containing: │ │ ├─ list.go │ │
• Daily Solutions│ │ ├─ math.go │ │
• Test Files │ │ └─ string.go │ │
• Input Files │ │ │ │
• ┘ └──────────────────────────┘ │
• ┘
Flow Indicators
• Dependencies between solutions and shared utilities
• Data flow from input files to solution modules
• Test execution paths
Implementation Details
Specific components:
• Main execution entry point (main.go)
• Solution structure (dayN.go files)
• Test suite organization
• Utility function groupings
The test-driven development approach
Keep the abstraction level focused on the architectural organization while showing the clear separation between solution modules and shared utilities. This will help developers understand both the overall structure and how to add new solutions maintaining the established patterns.
Remember to include notes about:
• The standardized file naming convention
• The relationship between test files and solution files
• The utility package organization
• The input file handling pattern