#终端颜色 #颜色字符串 #字符串 #ANSI终端 #终端 #颜色 #终端绘制

afetch-colored

在您的终端中添加颜色的最简单方式

4个稳定版本

2.0.4 2024年4月10日
2.0.3 2023年6月6日
2.0.1 2023年4月1日

156命令行界面 中排名

每月 25 次下载
afetch 中使用

MPL-2.0 许可证

91KB
2K SLoC

着色

Crates.io Crates.io

着色终端非常简单,您已经知道如何操作了!

    "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.rsmain.rs

    extern crate colored; // not needed in Rust 2018+

    use colored::Colorize;

    // 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 支持真彩色,您可以指定任何任意的 rgb 值。

此功能只能在支持真彩色的终端中正确工作(即大多数现代终端)。

您可以通过检查终端上的环境变量 $COLORTERM 的值来检查您的终端是否支持真彩色。值为 truecolor24bit 表示它将正常工作。

样式

  • 粗体
  • 下划线
  • 斜体
  • 暗淡
  • 反转
  • 闪烁
  • 隐藏
  • 删除线

您可以通过使用 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 软件包 colored,这个库就不会是现在这样。

感谢 ansi_term crate 提供参考实现,这对制作正确输出的字符串非常有帮助。

最低支持的 Rust 版本 (MSRV)

当前的 MSRV 是 1.70,该版本将通过 CI 自动检查和强制执行。这个版本可能在未来的小版本更新中发生变化,因此如果您需要特定的 Rust 版本,您应该使用受限的版本要求,例如 ~X.Y

许可证

Mozilla Public License 2.0。请参阅仓库根目录下的 LICENSE 文件。

在非法律术语中,这意味着

  • 如果您修复了一个错误,您必须给我修复的代码(这是公平的)
  • 如果您更改/扩展了 API,您必须给我您更改的文件中的代码,这些文件受 MPL2 保护。
  • 您不能因任何关于此代码的事情起诉我
  • 除此之外,您几乎可以随心所欲。有关详细信息,请参阅 LICENSE 文件。

贡献者

依赖项

~0–11MB
~68K SLoC