Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

metadata: add repository #45

Merged
merged 1 commit into from
Jun 14, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
//!
//! - Homepage: https://github.com/yoshuawuyts/human-panic
//! - Authors: Yoshua Wuyts <yoshuawuyts@gmail.com>
//! - Repository: https://github.com/yoshuawuyts/human-panic
//!
//! 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.
//!
Expand Down Expand Up @@ -70,6 +71,8 @@ pub struct Metadata {
pub authors: Cow<'static, str>,
/// The URL of the crate's website
pub homepage: Cow<'static, str>,
/// The URL of the crate's repository
pub repository: Cow<'static, str>,
}

/// `human-panic` initialisation macro
Expand All @@ -90,6 +93,7 @@ pub struct Metadata {
/// version: env!("CARGO_PKG_VERSION").into(),
/// authors: "My Company Support <support@mycompany.com".into(),
/// homepage: "support.mycompany.com".into(),
/// repository: "https://git.mycompany.com/repo.git".into(),
/// });
/// ```
#[macro_export]
Expand Down Expand Up @@ -127,6 +131,7 @@ macro_rules! setup_panic {
name: env!("CARGO_PKG_NAME").into(),
authors: env!("CARGO_PKG_AUTHORS").replace(":", ", ").into(),
homepage: env!("CARGO_PKG_HOMEPAGE").into(),
repository: option_env!("CARGO_PKG_REPOSITORY").unwrap_or("").into(),
};

panic::set_hook(Box::new(move |info: &PanicInfo| {
Expand All @@ -145,8 +150,13 @@ pub fn print_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 (_version, name, authors, homepage, repository) = (
&meta.version,
&meta.name,
&meta.authors,
&meta.homepage,
&meta.repository,
);

let stderr = BufferWriter::stderr(ColorChoice::Auto);
let mut buffer = stderr.buffer();
Expand Down Expand Up @@ -177,6 +187,9 @@ pub fn print_msg<P: AsRef<Path>>(
if !authors.is_empty() {
writeln!(&mut buffer, "- Authors: {}", authors)?;
}
if !repository.is_empty() {
writeln!(&mut buffer, "- Repository: {}", repository)?;
}
writeln!(
&mut buffer,
"\nWe take privacy seriously, and do not perform any \
Expand Down
1 change: 1 addition & 0 deletions tests/custom-panic/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ fn main() {
version: env!("CARGO_PKG_VERSION").into(),
authors: "My Company Support <support@mycompany.com".into(),
homepage: "support.mycompany.com".into(),
repository: "https://git.mycompany.com/repo.git".into(),
});

println!("A normal log message");
Expand Down