feat: add -g, --graph option for printing ASCII contribution graph

Author: jamieweavis

.github/screenshot.png

@@ -7,7 +7,7 @@
 [![version](https://img.shields.io/npm/v/streaker.svg)](https://github.com/jamieweavis/streaker-cli/releases)
 [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jamieweavis/streaker-cli/blob/main/LICENSE)
 
-<img width=335 alt="Screenshot" src="./.github/screenshot.png">
+<img width=593 alt="Screenshot" src="./.github/screenshot.png">
 
 ## Installation
 
@@ -17,10 +17,16 @@ npm install -g streaker
 
 ## Usage
 
+Display streak & contribution stats for a user:
 ```sh
 streaker <username>
 ```
 
+Display ASCII GitHub contribution graph for a user:
+```sh
+streaker <username> --graph
+```
+
 ## Related
 
 - [Streaker](https://github.com/jamieweavis/streaker) - 🔥 GitHub contribution streak & stat tracking menu bar app

README.md

@@ -39,7 +39,7 @@
   "dependencies": {
     "colorette": "^2.0.20",
     "commander": "^13.1.0",
-    "contribution": "^7.0.0"
+    "contribution": "^7.1.0"
   },
   "devDependencies": {
     "@biomejs/biome": "^1.9.4",
@@ -62,9 +62,7 @@
     "typescript": "5.7.3"
   },
   "release": {
-    "branches": [
-      "main"
-    ],
+    "branches": ["main"],
     "plugins": [
       "@semantic-release/changelog",
       "@semantic-release/commit-analyzer",
@@ -75,14 +73,9 @@
     ]
   },
   "lint-staged": {
-    "*.ts": [
-      "biome format --write",
-      "biome lint --write"
-    ]
+    "*.ts": ["biome format --write", "biome lint --write"]
   },
   "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ]
+    "extends": ["@commitlint/config-conventional"]
   }
 }

package-lock.json

@@ -10,10 +10,16 @@ const init = () => {
     .description(description)
     .version(version)
     .arguments('<username>')
+    .option(
+      '-g, --graph',
+      'output ASCII GitHub contribution graph instead of stats',
+    )
     .parse();
 
   const username = result.args[0]?.trim();
-  return run(username);
+  const options = result.opts();
+
+  return run(username, options.graph);
 };
 
 init();

package.json

@@ -0,0 +1,96 @@
+import { green } from 'colorette';
+import type { Contributions } from 'contribution';
+
+export function buildContributionGraph(contributions: Contributions): string {
+  // Define ASCII characters for different contribution levels
+  const levels = [' ', '░', '▒', '▓', '█'];
+
+  // Sort dates to ensure chronological order
+  const sortedDates = Object.keys(contributions).sort();
+  if (sortedDates.length === 0) return 'No data available';
+
+  // Group dates by week
+  const weeks: string[][] = [];
+  let currentWeek: string[] = [];
+
+  for (const dateStr of sortedDates) {
+    const currentDate = new Date(dateStr);
+
+    // Start new week if it's a Sunday
+    if (currentDate.getDay() === 0 && currentWeek.length > 0) {
+      weeks.push(currentWeek);
+      currentWeek = [];
+    }
+
+    currentWeek.push(dateStr);
+  }
+
+  // Add the last week if it's not empty
+  if (currentWeek.length > 0) {
+    weeks.push(currentWeek);
+  }
+
+  // Initialize the graph with proper dimensions
+  const dayLabels = ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'];
+  let graph = '';
+
+  // Add month labels at top of graph
+  const months: string[] = [];
+  const monthPositions: number[] = [];
+
+  weeks.forEach((week, weekIndex) => {
+    const firstDayOfWeek = new Date(week[0]);
+    const month = firstDayOfWeek.toLocaleString('default', { month: 'short' });
+
+    if (months.length === 0 || months[months.length - 1] !== month) {
+      months.push(month);
+      monthPositions.push(weekIndex);
+    }
+  });
+
+  // Add month labels
+  graph += '     ';
+  monthPositions.forEach((pos, idx) => {
+    const month = months[idx];
+    const nextPos =
+      idx < monthPositions.length - 1 ? monthPositions[idx + 1] : weeks.length;
+    // Adjust spacing to account for no spaces between week columns
+    const width = nextPos - pos;
+    const spaces = Math.max(0, width - month.length);
+
+    graph += month + ' '.repeat(spaces);
+  });
+  graph += '\n';
+
+  // Add a separator line
+  graph += `    ┌${'─'.repeat(weeks.length)}─\n`;
+
+  // Build the graph row by row (day by day)
+  for (let day = 0; day < 7; day++) {
+    graph += `${dayLabels[day]} │ `;
+
+    for (let weekIndex = 0; weekIndex < weeks.length; weekIndex++) {
+      const week = weeks[weekIndex];
+      let cell = ' ';
+
+      // Find the day in this week
+      for (const dateStr of week) {
+        const date = new Date(dateStr);
+        if (date.getDay() === day) {
+          const level = contributions[dateStr].gitHubLegendLevel;
+          cell = green(levels[level]);
+          break;
+        }
+      }
+
+      graph += cell; // No space added after each cell
+    }
+
+    graph += '\n';
+  }
+
+  // Add a bottom line
+  graph += `    └${'─'.repeat(weeks.length)}─`;
+
+  return graph;
+}

src/app.ts

@@ -1,7 +1,9 @@
 import { blue, red, yellow } from 'colorette';
 import { fetchGitHubStats } from 'contribution';
 
-export const run = async (username?: string) => {
+import { buildContributionGraph } from './contribution-graph';
+
+export const run = async (username?: string, showGraph?: boolean) => {
   try {
     if (!username) {
       console.error(
@@ -14,6 +16,12 @@ export const run = async (username?: string) => {
 
     const gitHubStats = await fetchGitHubStats(username);
 
+    if (showGraph) {
+      console.info(`
+${buildContributionGraph(gitHubStats.contributions)}`);
+      return process.exit(0);
+    }
+
     console.info(
       `
   ${blue('Streak')}