Dekor

Simple to use general character and styling library for Rust.

Features

• Ease of Use: Apply multiple text styles with a single macro call
• Safety: Compile-time checks prevent the use of invalid style names
• style!() macro which can be used to:
  • Generate a styled string for console output using ansi codes
  • Colors the text forground and background depending on passed parameters
  • Can bold, underline(Markdown doesn't do underlined), and italicize the text as desired and in any combination
• Utf8 enum contains various UTF-8 characters
  • Intention is to complete the list of characters - this will be accomplished over time
  • Character list source: https://www.fileformat.info/info/charset/UTF-8/list.htm
  • Implements Display and has the function .repeat(n) where n is usize

Getting Started

To start using Dekor, add the following to your Cargo.toml:

[dependencies]
dekor = "0.1.0"

• Minimum supported Rust version: 1.56.1

Usage

use dekor::*;

fn main() {
  let decorated_text = style!(Bold, Underline, FGBlue => "This is decorated text");
  let pipes = format!("{}\n{}{}\n{}{}",
    Utf8::VPipeSlim, 
    Utf8::JointPipeSlim, Utf8::HPipeSlim, 
    Utf8::NodePipeSlim, Utf8::HPipeSlim,
  );

  // Output:
  // This is decorated text   <-- Will be blue text that is underlined and bolded
  // │
  // ├—   <-- Note: Markdown will display the horizontal line slimmer than it is
  // └—
  println!("{}\n{}", decorated_text, pipes);
}

Example Output:

• Characters: Utf8::VPipeSlim, Utf8::JointPipeSlim, Utf8::NodePipeCurved, Utf8::HPipeSlim, and Utf8::ModLetterDownArrowhead
• Styles: FGBlue, Bold

use dekor::*;

fn main() {
  let folder = style!(FGBlue, Bold => "Folder"); // Style the folder
  let down_arrow = style!(Bold, FGGreen => Utf8::ModLetterDownArrowhead); // Style the open/close indicator
  let hpipe = Utf8::HPipeSlim.repeat(2); // `Utf8` implements `Display` and `.repeat()`
  println!("{}\n{}{}[{}]{}",
    Utf8::VPipeSlim, Utf8::JointPipeSlim, hpipe, down_arrow, folder
  );
}

Goals

• Create a macro which allows for text styling
• Allow for handling RGB and Hex inputs
• Import characters necessary for file tree display
• Import the remaining UTF-8 characters
• Look into using escape keys for these characters as some of them do not display properly

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

._. why would you do this?

• Assisting with importing all characters into the characters library would help greatly, just branch and make a pull request. Do your best to use the provided link and their naming schema to keep things consistent.