pavex_cli 0.2.10

The companion CLI for Pavex, a Rust framework to build API services and web applications.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

//! All environment variables that `pavex_cli` reads, apart from the ones
//! defined in the CLI args themselves, are defined here.
//!
//! The goal: avoid random `std::env::var` calls all over the place,
//! and instead have a single place where all environment variables are
//! defined and documented.

use std::path::PathBuf;

/// Set a specific `pavexc` binary to be used, regardless of the
/// logic that would otherwise be used to determine it.
pub fn pavexc_override() -> Option<PathBuf> {
    std::env::var("PAVEX_PAVEXC").ok().map(PathBuf::from)
}

/// This is an undocumented feature that allows us to force set the width of the
/// terminal as seen by the graphical error handler.
/// This is useful for testing/doc-generation purposes.
pub fn tty_width() -> Option<usize> {
    std::env::var("PAVEX_TTY_WIDTH")
        .ok()
        .and_then(|s| s.parse().ok())
}

/// The SHA of the commit that `pavex_cli` was built from.
pub const fn commit_sha() -> &'static str {
    env!("VERGEN_GIT_SHA")
}

/// The version of `pavex_cli` that is being used.
pub fn version() -> semver::Version {
    semver::Version::parse(env!("CARGO_PKG_VERSION"))
        .expect("CLI version is not valid according to SemVer")
}