fix: rework contributions heatmap squares #72
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughA new utility function was added to preprocess contribution data into weekly arrays, ensuring each week contains seven days and aligns with full weeks. The heatmap component now uses this processed data for rendering, updating its logic to iterate over structured weeks and days, and excluding future dates from display. Changes
Sequence Diagram(s)sequenceDiagram
participant UI
participant ContributionsHeatmap
participant getHeatmapWeeks
UI->>ContributionsHeatmap: Render
ContributionsHeatmap->>getHeatmapWeeks: Process raw contribution data
getHeatmapWeeks-->>ContributionsHeatmap: Return array of weeks (each with 7 days)
ContributionsHeatmap->>UI: Render heatmap grid (weeks x days)
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches
🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/components/features/contributor/contributions-heatmap.tsx (1)
69-112: Well-implemented utility function with solid edge case handling.The function correctly:
- Sorts input data chronologically
- Pads weeks to start on Monday and end on Sunday
- Filters out future dates
- Chunks data into weekly arrays
The padding logic is mathematically sound and handles all weekday scenarios properly.
Consider adding a brief JSDoc comment to document the function's purpose and behavior:
+/** + * Preprocesses heatmap data into weekly arrays, ensuring each week has 7 days + * and aligns with Monday-Sunday weeks. Filters out future dates. + */ const getHeatmapWeeks = (data: HeatmapDay[]): HeatmapDay[][] => {
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/components/features/contributor/contributions-heatmap.tsx(2 hunks)
🔇 Additional comments (3)
src/components/features/contributor/contributions-heatmap.tsx (3)
2-2: LGTM!The
useMemoimport is correctly added and used to optimize the expensive heatmap data preprocessing.
114-115: Excellent performance optimization.Using
useMemohere is appropriate given the computational complexity ofgetHeatmapWeeks. The dependency array correctly tracks changes to the input data.
122-133: Improved rendering logic with better flexibility.The new approach dynamically renders weeks based on preprocessed data rather than assuming a fixed grid structure. This ensures:
- Each week column contains exactly 7 days
- No empty cells in incomplete weeks
- Proper handling of variable data ranges
The component props are correctly passed and React keys are appropriately set.
We could maybe put the latest days to the left and the oldest ones to the right. What do you think? |
Summary by CodeRabbit