feat: Add date_format parameter

Author: DenverCoder1

src/card.php

@@ -4,17 +4,19 @@
  * Convert date from Y-M-D to more human-readable format
  *
  * @param string $dateString String in Y-M-D format
- * @return string formatted Date string
+ * @param string $format Date format to use
+ * @return string Formatted Date string
  */
-function formatDate(string $dateString): string
+function formatDate(string $dateString, string $format): string
 {
     $date = new DateTime($dateString);
     // if current year, display only month and day
     if (date_format($date, "Y") == date("Y")) {
-        return date_format($date, "M j");
+        // remove brackets and all text within them
+        return date_format($date, preg_replace("/\[.*?\]/", "", $format));
     }
-    // otherwise, display month, day, and year
-    return date_format($date, "M j, Y");
+    // otherwise, display month, day, and year (just brackets removed)
+    return date_format($date, str_replace(array("[", "]"), "", $format));
 }
 
 /**
@@ -87,24 +89,29 @@ function generateCard(array $stats, array $params = null): string
     // get requested theme, use $_REQUEST if no params array specified
     $theme = getRequestedTheme($params ?? $_REQUEST);
 
+    // get date format
+    $dateFormat = isset(($params ?? $_REQUEST)["date_format"]) 
+        ? ($params ?? $_REQUEST)["date_format"] 
+        : "M j[, Y]";
+
     // total contributions
     $totalContributions = $stats["totalContributions"];
-    $firstContribution = formatDate($stats["firstContribution"]);
+    $firstContribution = formatDate($stats["firstContribution"], $dateFormat);
     $totalContributionsRange = $firstContribution . " - Present";
 
     // current streak
     $currentStreak = $stats["currentStreak"]["length"];
-    $currentStreakStart = formatDate($stats["currentStreak"]["start"]);
-    $currentStreakEnd = formatDate($stats["currentStreak"]["end"]);
+    $currentStreakStart = formatDate($stats["currentStreak"]["start"], $dateFormat);
+    $currentStreakEnd = formatDate($stats["currentStreak"]["end"], $dateFormat);
     $currentStreakRange = $currentStreakStart;
     if ($currentStreakStart != $currentStreakEnd) {
         $currentStreakRange .= " - " . $currentStreakEnd;
     }
 
     // longest streak
     $longestStreak = $stats["longestStreak"]["length"];
-    $longestStreakStart = formatDate($stats["longestStreak"]["start"]);
-    $longestStreakEnd = formatDate($stats["longestStreak"]["end"]);
+    $longestStreakStart = formatDate($stats["longestStreak"]["start"], $dateFormat);
+    $longestStreakEnd = formatDate($stats["longestStreak"]["end"], $dateFormat);
     $longestStreakRange = $longestStreakStart;
     if ($longestStreakStart != $longestStreakEnd) {
         $longestStreakRange .= " - " . $longestStreakEnd;

tests/OptionsTest.php

@@ -169,7 +169,7 @@ public function testHideBorder(): void
     public function testDateFormatSameYear(): void
     {
         $year = date("Y");
-        $formatted = formatDate("$year-04-12");
+        $formatted = formatDate("$year-04-12", "M j[, Y]");
         $this->assertEquals("Apr 12", $formatted);
     }
 
@@ -178,7 +178,7 @@ public function testDateFormatSameYear(): void
      */
     public function testDateFormatDifferentYear(): void
     {
-        $formatted = formatDate("2000-04-12");
+        $formatted = formatDate("2000-04-12", "M j[, Y]");
         $this->assertEquals("Apr 12, 2000", $formatted);
     }
 }