1 个稳定版本
2.1.1 | 2023 年 12 月 25 日 |
---|
#666 在 命令行界面
在 3 个 crate 中使用(通过 toolstr)
90KB
2K SLoC
着色
终端着色如此简单,您已经知道如何做了!
"this is blue".blue();
"this is red".red();
"this is red on blue".red().on_blue();
"this is also red on blue".on_blue().red();
"you can use truecolor values too!".truecolor(0, 255, 136);
"background truecolor also works :)".on_truecolor(135, 28, 167);
"truecolor from tuple".custom_color((0, 255, 136));
"background truecolor from tuple".on_custom_color((0, 255, 136));
"bright colors are welcome as well".on_bright_blue().bright_red();
"you can also make bold comments".bold();
println!("{} {} {}", "or use".cyan(), "any".italic().yellow(), "string type".cyan());
"or change advice. This is red".yellow().blue().red();
"or clear things up. This is default color and style".red().bold().clear();
"purple and magenta are the same".purple().magenta();
"and so are normal and clear".normal().clear();
"you can specify color by string".color("blue").on_color("red");
String::from("this also works!").green().bold();
format!("{:30}", "format works as expected. This will be padded".blue());
format!("{:.3}", "and this will be green but truncated to 3 chars".green());
如何使用
在您的 Cargo.toml
中添加以下内容
[dependencies]
colored = "2"
并将以下内容添加到您的 lib.rs
或 main.rs
extern crate colored; // not needed in Rust 2018+
use colored::*;
// test the example with `cargo run --example most_simple`
fn main() {
// TADAA!
println!("{} {} !", "it".green(), "works".blue().bold());
}
特性
- 安全 Rust,易于使用,最小依赖,完整的测试套件
- 尊重
CLICOLOR/
CLICOLOR_FORCE
的行为(参见 规范) - 尊重
NO_COLOR
的行为(参见 规范) - 请注意,
CLICOLOR_FORCE
覆盖NO_COLOR
,而NO_COLOR
覆盖CLICOLOR
- 在 Linux、MacOS 和 Windows(Powershell)上运行
颜色
- 黑色
- 红色
- 绿色
- 黄色
- 蓝色
- 洋红色(或紫色)
- 青色
- 白色
亮色:颜色前缀为 bright_
。如此简单。背景颜色:颜色前缀为 on_
。就这么简单。亮色背景:颜色前缀为 on_bright_
。一点也不难。
真彩色
Colored 支持 truecolors,您可以指定任何任意 rgb 值。
此功能只能在支持 true colors 的终端中正确运行(即大多数现代终端)。
您可以通过检查终端上的环境变量 $COLORTERM
的值来检查您的终端是否支持 true color。值为 truecolor
或 24bit
表示它将正常工作。
样式
- 粗体
- 下划线
- 斜体
- 暗淡
- 反转
- 闪烁
- 隐藏
- 删除线
您可以通过使用 normal()
或 clear()
来随时清除颜色和样式。
高级控制
从字符串动态获取颜色
由于 Color
实现了 FromStr
,即 From<&str>
和 From<String>
,您可以轻松地将字符串转换为颜色,如下所示
// the easy way
"blue string yo".color("blue");
// this will default to white
"white string".color("zorglub");
// the safer way via a Result
let color_res : Result<Color, ()> = "zorglub".parse();
"red string".color(color_res.unwrap_or(Color::Red));
着色控制
如果您想在编译时禁用任何着色,可以使用 no-color
功能轻松实现。
例如,您可以在您的 Cargo.toml
中这样做以在测试中禁用颜色
[features]
# this effectively enable the feature `no-color` of colored when testing with
# `cargo test --feature dumb_terminal`
dumb_terminal = ["colored/no-color"]
您还可以使用 colored::control::set_override
方法进行更精细的控制。
待办事项
- 更多测试? 我们始终欢迎更多的测试!请贡献力量!
致谢
这个库如果没有这个神奇的 Ruby gem colored 将不会是现在这样。
感谢 ansi_term crate 提供了参考实现,这极大地帮助了这个 crate 正确输出字符串。
最低支持 Rust 版本 (MSRV)
当前的 MSRV 是 1.70
,它将通过 CI 自动检查和执行。这个版本可能会在未来的小版本更新中改变,所以如果您需要特定的 Rust 版本,您应该使用限制性版本要求,如 ~X.Y
。
许可协议
Mozilla Public License 2.0。请参阅存储库根目录下的 LICENSE 文件。
在非法律术语中,这意味着
- 如果您修复了一个错误,您必须给我修复的代码(这是公平的)
- 如果您更改/扩展了 API,您必须给我更改的 MPL2 下的文件的代码。
- 您不能因为此代码的任何内容起诉我
- 除此之外,您可以几乎做任何您想做的事情。请参阅 LICENSE 文件以获取详细信息。
贡献者
- Thomas Wickham: @mackwic
- Hunter Wittenborn @hwittenborn
- Corey "See More" Richardson: @cmr
- Iban Eguia: @Razican
- Alexis "Horgix" Chotard: @horgix
- Keith Yeung: @KiChjang
- Kyle Galloway: @kylegalloway
- Luke Hsiao: @lukehsiao
- kurtlawrence: @kurtlawrence
依赖项
~0–12MB
~87K SLoC