Merge pull request #138 from tisonkun/add-supports-links

feat: Add `support` section
rust-cli · Apr 17, 2024 · d047a87 · d047a87
2 parents 259bc32 + 2d6b767
commit d047a87
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 5 deletions.
diff --git a/src/lib.rs b/src/lib.rs
@@ -60,6 +60,7 @@ pub struct Metadata {
     version: Cow<'static, str>,
     authors: Option<Cow<'static, str>>,
     homepage: Option<Cow<'static, str>>,
+    support: Option<Cow<'static, str>>,
 }
 
 impl Metadata {
@@ -70,6 +71,7 @@ impl Metadata {
             version: version.into(),
             authors: None,
             homepage: None,
+            support: None,
         }
     }
 
@@ -90,6 +92,15 @@ impl Metadata {
         }
         self
     }
+
+    /// The support information
+    pub fn support(mut self, value: impl Into<Cow<'static, str>>) -> Self {
+        let value = value.into();
+        if !value.is_empty() {
+            self.support = value.into();
+        }
+        self
+    }
 }
 
 /// Initialize [`Metadata`]
@@ -121,6 +132,7 @@ macro_rules! metadata {
 /// setup_panic!(Metadata::new(env!("CARGO_PKG_NAME"), env!("CARGO_PKG_VERSION"))
 ///     .authors("My Company Support <support@mycompany.com>")
 ///     .homepage("support.mycompany.com")
+///     .support("- Open a support request by email to support@mycompany.com")
 /// );
 /// ```
 #[macro_export]
@@ -206,8 +218,13 @@ fn write_msg<P: AsRef<Path>>(
     file_path: Option<P>,
     meta: &Metadata,
 ) -> IoResult<()> {
-    let (_version, name, authors, homepage) =
-        (&meta.version, &meta.name, &meta.authors, &meta.homepage);
+    let Metadata {
+        name,
+        authors,
+        homepage,
+        support,
+        ..
+    } = meta;
 
     writeln!(buffer, "Well, this is embarrassing.\n")?;
     writeln!(
@@ -233,6 +250,9 @@ fn write_msg<P: AsRef<Path>>(
     if let Some(authors) = authors {
         writeln!(buffer, "- Authors: {authors}")?;
     }
+    if let Some(support) = support {
+        writeln!(buffer, "\nTo submit the crash report:\n\n{support}")?;
+    }
     writeln!(
         buffer,
         "\nWe take privacy seriously, and do not perform any \

diff --git a/tests/custom-panic/src/main.rs b/tests/custom-panic/src/main.rs
@@ -4,7 +4,8 @@ use human_panic::setup_panic;
 fn main() {
     setup_panic!(metadata!()
         .authors("My Company Support <support@mycompany.com")
-        .homepage("support.mycompany.com"));
+        .homepage("www.mycompany.com")
+        .support("- Open a support request by email to support@mycompany.com"));
 
     println!("A normal log message");
     panic!("OMG EVERYTHING IS ON FIRE!!!");

diff --git a/tests/custom-panic/tests/integration.rs b/tests/custom-panic/tests/integration.rs
@@ -10,9 +10,13 @@ fn release() {
 
             We have generated a report file at "[..].toml". Submit an issue or email with the subject of "custom-panic-test Crash Report" and include the report as an attachment.
 
-            - Homepage: support.mycompany.com
+            - Homepage: www.mycompany.com
             - Authors: My Company Support <support@mycompany.com
 
+            To submit the crash report:
+
+            - Open a support request by email to support@mycompany.com
+
             We take privacy seriously, and do not perform any automated error collection. In order to improve the software, we rely on people to submit reports.
 
             Thank you kindly!
@@ -26,7 +30,7 @@ fn debug() {
     snapbox::cmd::Command::new(snapbox::cmd::cargo_bin!("custom-panic-test"))
         .assert()
         .stderr_matches(snapbox::str![[r#"
-            thread 'main' panicked at tests/custom-panic/src/main.rs:10:5:
+            thread 'main' panicked at tests/custom-panic/src/main.rs:11:5:
             OMG EVERYTHING IS ON FIRE!!!
             note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace
         "#]])