cfonts 1.3.0

Sexy ANSI fonts for the console
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

//! The contents of this module is all about cli specific functionality
use std::env;
use std::fmt::Write as _;

use crate::color::{color, get_term_color_support, TermColorSupport};
use crate::config::{Align, BgColors, Colors, Env, Fonts, OptionType, Options, CLIOPTIONS};
use crate::debug::{d, Dt};
use crate::render::render;

/// Return the string to display when the `version` option is passed in via the [`Options`] struct
///
/// ```rust
/// extern crate cfonts;
///
/// use cfonts::Options;
/// use cfonts::cli::version;
///
/// let options = Options::default();
/// assert_eq!(version(&options), format!("v{}", env!("CARGO_PKG_VERSION")));
/// ```
pub fn version(options: &Options) -> String {
	d("cli::version()", 5, Dt::Head, options, &mut std::io::stdout());

	let version = env!("CARGO_PKG_VERSION");
	d(&format!("cli::version() version: {}", version), 5, Dt::Log, options, &mut std::io::stdout());

	format!("v{}", version)
}

/// Return the string to display when the `help` option is passed in via the [`Options`] struct
///
/// ```rust
/// extern crate cfonts;
///
/// use cfonts::Options;
/// use cfonts::cli::help;
///
/// let options = Options::default();
/// assert!(help(&options).contains("Usage:"));
/// ```
pub fn help(options: &Options) -> String {
	d("cli::help()", 5, Dt::Head, options, &mut std::io::stdout());

	let mut output = String::new();
	let render_options = render(Options {
		text: String::from("cfonts"),
		align: Align::Left,
		gradient: vec![String::from("#ff0000"), String::from("#00ff00")],
		spaceless: true,
		..Options::default()
	});

	let (bold_start, bold_end) = if get_term_color_support() == TermColorSupport::NoColor {
		(String::from(""), String::from(""))
	} else {
		(String::from("\x1b[1m"), String::from("\x1b[22m"))
	};

	output += "\n\n";
	output += &render_options.text;
	output += "\n\n";
	output += "This is a tool for sexy fonts in the console. Give your cli some love.\n";
	output += "\n";
	output += "Usage: cfonts \"<value>\" [option1] <input1> [option2] <input1>,<input2> [option3]\n";
	let _ =
		writeln!(output, "Example: {}$ cfonts \"sexy font\" -f chrome -a center -c red,green,gray{}", bold_start, bold_end);
	output += "\n";
	output += "Options:\n";

	for option in CLIOPTIONS {
		let _ = write!(output, "\n{}{}, {}", bold_start, option.name, option.shortcut);
		if !option.fallback_shortcut.is_empty() {
			let _ = write!(output, ", {}", option.fallback_shortcut);
		}
		let _ = writeln!(output, "{}", bold_end);
		let _ = writeln!(output, "{}", option.description);
		let _ = write!(output, "{}${} cfonts {}", bold_start, bold_end, option.example);
		match option.kind {
			OptionType::Font => {
				output += &color(&format!(" [ {} ]", Fonts::list()), Colors::Green).to_string();
			}
			OptionType::Colors => {
				output += &color(&format!(" [ {} ]", Colors::list()), Colors::Green).to_string();
			}
			OptionType::BgColor => {
				output += &color(&format!(" [ {} ]", BgColors::list()), Colors::Green).to_string();
			}
			OptionType::Align => {
				output += &color(&format!(" [ {} ]", Align::list()), Colors::Green).to_string();
			}
			OptionType::Env => {
				output += &color(&format!(" [ {} ]", Env::list()), Colors::Green).to_string();
			}
			_ => {}
		}
		output += "\n";
	}

	output
}