r3blansicolor crate

• What does it do?
• Build, run, test tasks
• References

What does it do?

Rust crate to generate formatted ANSI 256 (8-bit) and truecolor (24-bit) color output to stdout. On macOS, the default Terminal.app does not support truecolor, so ANSI 256 colors are used instead.

This crate only has a single dependency which is the concolor-query crate. It is used to determine whether the terminal supports truecolor or ANSI 256 colors, etc. Both this crate and the concolor-query crate are licensed under the Apache 2.0 license.

Here's a screenshot of running the main example:

How to use it?

The main struct that we have to consider is AnsiStyledText. It has two fields:

• text - the text to print.
• style - a list of styles to apply to the text.

Here's an example.

rust AnsiStyledText { text: "Print a formatted (bold, italic, underline) string w/ ANSI color codes.", style: &[ Style::Bold, Style::Italic, Style::Underline, Style::Foreground(Color::Rgb(50, 50, 50)), Style::Background(Color::Rgb(100, 200, 1)), ], } .println();

Please a look at the main example to get a better idea of how to use this crate.

Build, run, test tasks

• Build: cb
• Run examples: cr --example main
• Run tests: ct

Fish scripts are provided to facilitate the above tasks. Here is a list of them.

• Build
  1. build.fish - build the crate.
• Run
  1. run.fish - run the examples.
  2. run-watch.fish - watch the files in this folder and re-run the examples when they change.
  3. run-release.fish - run the examples in release mode.
  4. run-with-flamegraph-profiling.fish - run the examples with flamegraph profiling.
• Test
  1. cargo-watch-all-tests.fish - watch the files in this folder and re-run the tests when
  2. test.fish - run the tests.
  3. cargo-watch-one-test.fish - same as above, but just watch a single test passed in as an argument to this script.
  4. cargo-watch-macro-expand-one-test.fish - same as above, but also expand all the macros that are used in the test.
• Clippy
  1. clippy.fish - run clippy and re-run it when the files in this folder change.
• Docs
  1. doc.fish - generate the Rust docs.
  2. serve-doc.fish - serve the Rust docs on http://localhost:3000. This is useful when using SSH to connect to a remote machine to actually do development work on and you want to view the docs on your local machine. Make sure you have node and npm and serve installed. If not you can get it with brew.

References

• https://notes.burke.libbey.me/ansi-escape-codes/
• https://www.asciitable.com/
• https://commons.wikimedia.org/wiki/File:Xterm256colorchart.svg
• https://www.ditig.com/256-colors-cheat-sheet
• https://stackoverflow.com/questions/4842424/list-of-ansi-color-escape-sequences
• https://www.compuphase.com/cmetric.htm