build-print

Crates.iobuild-print
lib.rsbuild-print
version0.1.1
sourcesrc
created_at2024-09-27 14:28:41.890448
updated_at2024-09-27 14:32:14.25697
descriptionbuild-print is a crate that allows you to print non-warning messages from within rust build scripts
homepage
repository
max_upload_size
id1388685
size97,513
Sam Johnson (sam0x17)

documentation

README

build-print

A simple set of macros that allow regular printing as well as properly formatted info, warnings, errors, and notes during build scripts.

Traditionally, there are only two ways to print to the console during a build script:

  • println!("cargo:warning=...") to print a somewhat annoyingly formatted warning message
  • panic!(..) to halt the build process and print an error message

Regular println! statements are not shown during the build process, so this crate hijacks the cargo:warning=... variant using ANSI escape sequences to produce a working println! macro as well as info!, warn!, error!, and note! macros that following the indentation and coloring of standard cargo diagnostic messages.

You can also define your own custom print messages using the custom_println! macro, which is also the basis for the other macros.

Example

// build.rs
use build_print::{println, *};

fn main() {
    println!("regular println works");
    info!("hello world");
    warn!("hello world");
    error!("hello world");
    note!("hello world");
    custom_println!("Documenting", green, "hello world");
}

Commit count: 0

cargo fmt