build-print 1.0.1

build-print is a crate that allows you to print non-warning messages from within rust build scripts
Documentation
  • Coverage
  • 100%
    7 out of 7 items documented1 out of 1 items with examples
  • Size
  • Source code size: 91.13 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 1.24 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 12s Average build duration of successful builds.
  • all releases: 9s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • sam0x17/build-print
    4 0 2
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • sam0x17

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");
}