rome_console

Crates.iorome_console
lib.rsrome_console
version0.0.1
sourcesrc
created_at2023-04-04 08:46:49.065054
updated_at2023-04-04 08:46:49.065054
descriptionExpose utilities to print HTML-syntax messages
homepage
repositoryhttps://github.com/rome/tools
max_upload_size
id829991
size43,517
Emanuele Stoppa (ematipico)

documentation

https://rustdocs.rome.tools/rome_console/index.html

README

rome_console

The crate contains a general abstraction over printing messages (formatted with markup) and diagnostics to a console.

Local installation

rome_console = { version = "0.0.0", path = "../rome_console" }

Usage example

The Console trait can be used to print two types of information to the user: messages (in the form of markup) and diagnostics:

console.message(markup! {
    <Info>"Processed "<Emphasis>{count}</Emphasis>" files"</Info>
});

console.diagnostic(
    &mut files,
    Diagnostics::error(file_id, code, title),
);

The following markup elements are supported:

  • Emphasis: Print the content in bold text
  • Dim: Print the content in dimmed text
  • Italic: Print the content in italic text
  • Underline: Print the content in underlined text
  • Error: Set the text color to red
  • Success: Set the text color to green
  • Warn: Set the text color to yellow
  • Info: Set the text color to blue

Note: Markup elements that change the "font" of the printed text (Emphasis, Dim, Italic and Underline) are not supported by the native Windows Console API and will instead get printed as ANSI control codes if the current terminal supports it, or will be ignored entirely

Commit count: 4306

cargo fmt