bare-script 0.1.1

The type-safe scripting authority for Rust. A framework for building robust shell commands and automation with 'Parse, don't validate' philosophy.
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

//! Logging support for bare-script.
//!
//! This module provides logging functionality when the `logging` feature is enabled.

#[cfg(feature = "logging")]
use log::{debug, error, info, warn};

/// Logs command execution details.
#[cfg(feature = "logging")]
pub fn log_command(program: &str, args: &[std::ffi::OsString]) {
    let args_str: Vec<String> = args
        .iter()
        .map(|s| s.to_string_lossy().to_string())
        .collect();

    debug!("Executing command: {} {:?}", program, args_str);
}

/// Logs command success.
#[cfg(feature = "logging")]
pub fn log_success(program: &str, exit_code: Option<i32>) {
    info!(
        "Command '{}' completed with exit code: {:?}",
        program, exit_code
    );
}

/// Logs command failure.
#[cfg(feature = "logging")]
pub fn log_failure(program: &str, exit_code: Option<i32>, stderr: &str) {
    error!(
        "Command '{}' failed with exit code: {:?}, stderr: {}",
        program, exit_code, stderr
    );
}

/// Logs timeout.
#[cfg(feature = "logging")]
pub fn log_timeout(program: &str, duration: std::time::Duration) {
    warn!("Command '{}' timed out after {:?}", program, duration);
}

/// Logs environment variable changes.
#[cfg(feature = "logging")]
pub fn log_env_set(key: &str, value: &str) {
    debug!("Setting environment variable: {}={}", key, value);
}

/// Logs working directory change.
#[cfg(feature = "logging")]
pub fn log_cwd(path: &std::path::Path) {
    debug!("Changing working directory to: {:?}", path);
}

/// No-op implementations when logging is disabled.
#[cfg(not(feature = "logging"))]
#[allow(missing_docs)]
pub fn log_command(_program: &str, _args: &[std::ffi::OsString]) {}

#[cfg(not(feature = "logging"))]
#[allow(missing_docs)]
pub fn log_success(_program: &str, _exit_code: Option<i32>) {}

#[cfg(not(feature = "logging"))]
#[allow(missing_docs)]
pub fn log_failure(_program: &str, _exit_code: Option<i32>, _stderr: &str) {}

#[cfg(not(feature = "logging"))]
#[allow(missing_docs)]
pub fn log_timeout(_program: &str, _duration: std::time::Duration) {}

#[cfg(not(feature = "logging"))]
#[allow(missing_docs)]
pub fn log_env_set(_key: &str, _value: &str) {}

#[cfg(not(feature = "logging"))]
#[allow(missing_docs)]
pub fn log_cwd(_path: &std::path::Path) {}