og_image: Make description and license optional and add version prefix in template

Author: Turbo87

crates/crates_io_og_image/README.md

@@ -35,9 +35,9 @@ async fn main() -> Result<(), OgImageError> {
     // Define the crate data
     let data = OgImageData {
         name: "example-crate",
-        version: "v1.2.3",
-        description: "An example crate for testing OpenGraph image generation",
-        license: "MIT/Apache-2.0",
+        version: "1.2.3",
+        description: Some("An example crate for testing OpenGraph image generation"),
+        license: Some("MIT/Apache-2.0"),
         tags: &["example", "testing", "og-image"],
         authors: &[
             OgImageAuthorData::with_url(

crates/crates_io_og_image/examples/test_generator.rs

@@ -22,9 +22,9 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
     // Test generating an image
     let data = OgImageData {
         name: "example-crate",
-        version: "v1.2.3",
-        description: "An example crate for testing OpenGraph image generation",
-        license: "MIT/Apache-2.0",
+        version: "1.2.3",
+        description: Some("An example crate for testing OpenGraph image generation"),
+        license: Some("MIT/Apache-2.0"),
         tags: &["example", "testing", "og-image"],
         authors: &[
             OgImageAuthorData::new("example-user", None),

crates/crates_io_og_image/src/lib.rs

@@ -22,12 +22,12 @@ use tracing::{debug, error, info, instrument, warn};
 pub struct OgImageData<'a> {
     /// The crate name
     pub name: &'a str,
-    /// Latest version string (e.g., "v1.0.210")
+    /// Latest version string (e.g., "1.0.210")
     pub version: &'a str,
     /// Crate description text
-    pub description: &'a str,
+    pub description: Option<&'a str>,
     /// License information (e.g., "MIT/Apache-2.0")
-    pub license: &'a str,
+    pub license: Option<&'a str>,
     /// Keywords/categories for the crate
     pub tags: &'a [&'a str],
     /// Author information
@@ -310,9 +310,9 @@ impl OgImageGenerator {
     /// let generator = OgImageGenerator::default();
     /// let data = OgImageData {
     ///     name: "my-crate",
-    ///     version: "v1.0.0",
-    ///     description: "A sample crate",
-    ///     license: "MIT",
+    ///     version: "1.0.0",
+    ///     description: Some("A sample crate"),
+    ///     license: Some("MIT"),
     ///     tags: &["web", "api"],
     ///     authors: &[OgImageAuthorData { name: "user", avatar: None }],
     ///     lines_of_code: Some(5000),
@@ -575,9 +575,9 @@ mod tests {
 
         OgImageData {
             name: "minimal-crate",
-            version: "v1.0.0",
-            description: "A minimal crate",
-            license: "MIT",
+            version: "1.0.0",
+            description: None,
+            license: None,
             tags: &[],
             authors: AUTHORS,
             lines_of_code: None,
@@ -595,9 +595,11 @@ mod tests {
 
         OgImageData {
             name: "crate-with-\"quotes\"",
-            version: "v1.0.0-\"beta\"",
-            description: "A crate with \"quotes\", \\ backslashes, and other special chars: #[]{}()",
-            license: "MIT OR \"Apache-2.0\"",
+            version: "1.0.0-\"beta\"",
+            description: Some(
+                "A crate with \"quotes\", \\ backslashes, and other special chars: #[]{}()",
+            ),
+            license: Some("MIT OR \"Apache-2.0\""),
             tags: &[
                 "tag-with-\"quotes\"",
                 "tag\\with\\backslashes",
@@ -626,9 +628,11 @@ mod tests {
 
         OgImageData {
             name: "super-long-crate-name-for-testing-overflow-behavior",
-            version: "v2.1.0-beta.1+build.12345",
-            description: "This is an extremely long description that tests how the layout handles descriptions that might wrap to multiple lines or overflow the available space in the OpenGraph image template design. This is an extremely long description that tests how the layout handles descriptions that might wrap to multiple lines or overflow the available space in the OpenGraph image template design.",
-            license: "MIT/Apache-2.0/ISC/BSD-3-Clause",
+            version: "2.1.0-beta.1+build.12345",
+            description: Some(
+                "This is an extremely long description that tests how the layout handles descriptions that might wrap to multiple lines or overflow the available space in the OpenGraph image template design. This is an extremely long description that tests how the layout handles descriptions that might wrap to multiple lines or overflow the available space in the OpenGraph image template design.",
+            ),
+            license: Some("MIT/Apache-2.0/ISC/BSD-3-Clause"),
             tags: &[
                 "web-framework",
                 "async-runtime",
@@ -648,9 +652,9 @@ mod tests {
 
         OgImageData {
             name: "test-crate",
-            version: "v1.0.0",
-            description: "A test crate for OpenGraph image generation",
-            license: "MIT/Apache-2.0",
+            version: "1.0.0",
+            description: Some("A test crate for OpenGraph image generation"),
+            license: Some("MIT/Apache-2.0"),
             tags: &["testing", "og-image"],
             authors: AUTHORS,
             lines_of_code: Some(1000),

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

@@ -273,7 +273,9 @@
         }
 
         // Description
-        block(text(size: 14pt, weight: "regular", truncate_to_height(data.at("description", default: ""), maxHeight: 60pt)))
+        if data.at("description", default: none) != none {
+            block(text(size: 14pt, weight: "regular", truncate_to_height(data.description, maxHeight: 60pt)))
+        }
 
         // Authors
         if data.at("authors", default: ()).len() > 0 {
@@ -293,7 +295,7 @@
                 if data.at("releases", default: none) != none {
                     render-metadata("Releases", data.releases, "tag")
                 }
-                render-metadata("Latest", truncate_to_width(data.version, maxWidth: 80pt), "code-branch")
+                render-metadata("Latest", truncate_to_width("v" + data.version, maxWidth: 80pt), "code-branch")
                 if data.at("license", default: none) != none {
                     render-metadata("License", truncate_to_width(data.license, maxWidth: 100pt), "scale-balanced")
                 }