og_image: Improve releases and lines of code formatting

Author: Turbo87

crates/crates_io_og_image/src/formatting.rs

@@ -50,6 +50,51 @@ pub fn format_bytes(bytes: u32) -> String {
     }
 }
 
+/// Formats a number with "k" and "M" suffixes for thousands and millions.
+///
+/// The function follows these rules:
+/// - Uses suffixes: none, k, and M
+/// - Switches from no suffix to k at 1500
+/// - Switches from k to M at 1500 * 1000
+/// - Limits the number to a maximum of 4 characters by adjusting decimal places
+///
+/// # Arguments
+///
+/// * `number` - The number to format
+///
+/// # Returns
+///
+/// A formatted string representing the number with appropriate suffixes
+pub fn format_number(number: u32) -> String {
+    const THRESHOLD: f64 = 1500.;
+    const UNITS: &[&str] = &["", "k", "M"];
+
+    let mut value = number as f64;
+    let mut unit_index = 0;
+
+    // Keep dividing by 1000 until value is below threshold or we've reached the last unit
+    while value >= THRESHOLD && unit_index < UNITS.len() - 1 {
+        value /= 1000.0;
+        unit_index += 1;
+    }
+
+    let unit = UNITS[unit_index];
+
+    // Special case for numbers without suffix - no decimal places
+    if unit_index == 0 {
+        return format!("{}", number);
+    }
+
+    // For k and M, format with appropriate decimal places
+
+    // Determine number of decimal places to keep number under 4 chars
+    if value < 10.0 {
+        format!("{:.1}{}", value, unit)
+    } else {
+        format!("{:.0}{}", value, unit)
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
@@ -81,4 +126,32 @@ mod tests {
         assert_eq!(format_bytes(104857600), "100 MB");
         assert_eq!(format_bytes(1073741824), "1024 MB");
     }
+
+    #[test]
+    fn test_format_number() {
+        // Test numbers without suffix (below 1500)
+        assert_eq!(format_number(0), "0");
+        assert_eq!(format_number(1), "1");
+        assert_eq!(format_number(1000), "1000");
+        assert_eq!(format_number(1499), "1499");
+
+        // Test numbers with k suffix (1500 to 1500 * 1000)
+        assert_eq!(format_number(1500), "1.5k");
+        assert_eq!(format_number(2000), "2.0k");
+        assert_eq!(format_number(5000), "5.0k");
+        assert_eq!(format_number(10000), "10k");
+        assert_eq!(format_number(50000), "50k");
+        assert_eq!(format_number(100000), "100k");
+        assert_eq!(format_number(500000), "500k");
+        assert_eq!(format_number(999999), "1000k");
+
+        // Test numbers with M suffix (above 1500 * 1000)
+        assert_eq!(format_number(1500000), "1.5M");
+        assert_eq!(format_number(2000000), "2.0M");
+        assert_eq!(format_number(5000000), "5.0M");
+        assert_eq!(format_number(10000000), "10M");
+        assert_eq!(format_number(50000000), "50M");
+        assert_eq!(format_number(100000000), "100M");
+        assert_eq!(format_number(1000000000), "1000M");
+    }
 }

crates/crates_io_og_image/src/lib.rs

@@ -2,7 +2,7 @@
 
 mod formatting;
 
-use crate::formatting::format_bytes;
+use crate::formatting::{format_bytes, format_number};
 use anyhow::{Context, anyhow};
 use bytes::Bytes;
 use crates_io_env_vars::var;
@@ -29,6 +29,9 @@ static TEMPLATE_ENV: LazyLock<Environment<'_>> = LazyLock::new(|| {
     // Add custom filter for formatting byte sizes
     env.add_filter("format_bytes", format_bytes);
 
+    // Add custom filter for formatting numbers with k/M suffixes
+    env.add_filter("format_number", format_number);
+
     let template_str = include_str!("../templates/og-image.typ.j2");
     env.add_template("og-image.typ", template_str).unwrap();
     env

crates/crates_io_og_image/src/snapshots/crates_io_og_image__tests__generated_og_image_overflow.snap.png

@@ -279,7 +279,7 @@ expression: template_content
                 render-metadata("Releases", "15", "tag")
                 render-metadata("Latest", truncate_to_width("v2.1.0", maxWidth: 80pt), "code-branch")
                 render-metadata("License", truncate_to_width("MIT OR Apache-2.0", maxWidth: 100pt), "scale-balanced")
-                render-metadata("SLoC", "5500", "code")
+                render-metadata("SLoC", "5.5k", "code")
                 render-metadata("Size", "125 kB", "weight-hanging")
             })
         )

crates/crates_io_og_image/src/snapshots/crates_io_og_image__tests__generated_template.typ.snap

@@ -274,11 +274,11 @@
 
         place(bottom + left, float: true,
             stack(dir: ltr, {
-                render-metadata("Releases", "{{ data.releases }}", "tag")
+                render-metadata("Releases", "{{ data.releases | format_number }}", "tag")
                 render-metadata("Latest", truncate_to_width("{{ data.version | typst_escape }}", maxWidth: 80pt), "code-branch")
                 render-metadata("License", truncate_to_width("{{ data.license | typst_escape }}", maxWidth: 100pt), "scale-balanced")
                 {%- if data.lines_of_code %}
-                render-metadata("SLoC", "{{ data.lines_of_code }}", "code")
+                render-metadata("SLoC", "{{ data.lines_of_code | format_number }}", "code")
                 {%- endif %}
                 render-metadata("Size", "{{ data.crate_size | format_bytes }}", "weight-hanging")
             })