每月 30 个稳定版本

2.1.0 2023 年 12 月 10 日
2.0.4 2023 年 7 月 5 日
2.0.0 2020 年 7 月 14 日
1.9.4 2023 年 7 月 24 日
1.2.0 2016 年 3 月 30 日

#2命令行界面

Download history 334928/week @ 2024-04-30 328738/week @ 2024-05-07 344924/week @ 2024-05-14 347472/week @ 2024-05-21 371924/week @ 2024-05-28 363764/week @ 2024-06-04 357251/week @ 2024-06-11 351010/week @ 2024-06-18 356196/week @ 2024-06-25 323906/week @ 2024-07-02 382930/week @ 2024-07-09 405926/week @ 2024-07-16 411869/week @ 2024-07-23 452058/week @ 2024-07-30 478416/week @ 2024-08-06 459026/week @ 2024-08-13

1,879,544 每月下载量
4,185 个 crate(直接使用 2,850 个) 中使用

MPL-2.0 许可证

63KB
1.5K 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);
    "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::*;

    // 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_ 预先指定颜色。一点也不难。

真彩色

彩色支持真彩色,您可以指定任何任意 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 gem colored,这个库就不会是现在的样子。

感谢 ansi_term crate 提供参考实现,这极大地帮助了这个 crate 正确输出字符串。

最低支持的 Rust 版本 (MSRV)

当前的 MSRV 是 1.70,该版本会通过 CI 自动检查和强制执行。该版本可能会在未来的小版本升级中更改,因此如果您需要特定的 Rust 版本,您应该使用限制性版本要求,例如 ~X.Y

许可协议

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

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

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

贡献者

依赖项

~0–11MB
~67K SLoC