cli_fmt 0.10.1

CLI output formatting utilities for command-line 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
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
79
80
81
82

//! CLI output formatting utilities.
//!
//! This crate provides utilities for building command-line applications,
//! including output processing, formatting, and other CLI-specific helpers.
//!
//! # Modules
//!
//! - `output` - Process command output (head/tail filtering, width truncation, stream merging)
//! - `help` - Typed, configurable CLI help text renderer (`CliHelpTemplate`, `CliHelpStyle`, `CliHelpData`)
//!
//! # Architecture
//!
//! This crate focuses on CLI-application-specific functionality. For general-purpose
//! string and ANSI manipulation, use `strs_tools` instead.
//!
//! **Distinction:**
//! - `strs_tools`: Generic string/ANSI utilities (any application)
//! - `cli_fmt`: CLI-specific helpers (command-line tools only)
//!
//! # Examples
//!
//! ```rust
//! # #[ cfg( feature = "output" ) ]
//! # {
//! use cli_fmt::output::*;
//!
//! let config = OutputConfig::default()
//!   .with_head( 10 )
//!   .with_width( 80 );
//!
//! let result = process_output( "stdout text", "stderr text", &config );
//! println!( "{}", result.content );
//! # }
//! ```

#![ cfg_attr( not( feature = "enabled" ), allow( unused ) ) ]
#![ doc( html_logo_url = "https://raw.githubusercontent.com/Wandalen/wTools/master/asset/img/logo_v3_trans_square.png" ) ]

/// CLI output processing.
#[ cfg( any( feature = "output", feature = "output_passthrough" ) ) ]
pub mod output;

/// Structured CLI help template: data model + colour-aware renderer.
#[ cfg( feature = "cli_help_template" ) ]
pub mod help;

/// Namespace with dependencies.
pub mod dependency
{
  #[ cfg( feature = "enabled" ) ]
  pub use ::strs_tools;
}

/// Own namespace of the module.
pub mod own
{
  #[ cfg( any( feature = "output", feature = "output_passthrough" ) ) ]
  pub use super::output::orphan::*;
  #[ cfg( feature = "cli_help_template" ) ]
  pub use super::help::orphan::*;
}

/// Orphan namespace of the module.
pub mod orphan
{
}

/// Exposed namespace of the module.
pub mod exposed
{
  #[ allow( unused_imports ) ]
  pub use super::own::*;
}

/// Prelude to use essentials: `use cli_fmt::prelude::*`.
pub mod prelude
{
  #[ cfg( any( feature = "output", feature = "output_passthrough" ) ) ]
  pub use super::output::orphan::*;
  #[ cfg( feature = "cli_help_template" ) ]
  pub use super::help::orphan::*;
}