Crate conciliator

source · [−]
Expand description

WIP library for writing interactive CLI programs.

Currently very unstable with a somewhat unusual API. Subject to major changes as I use it and implement missing functionality. Intended to implement the things that the Python click library provides which are missing from clap. Using that basis, provide useful abstractions for interacting with the CLI.

Scope:

  • Pretty status, info, warn and error messages
  • Convenient traits and methods for printing color escape codes when available
  • Print lists and trees
  • Simplify dealing with terminal colors using “color palettes”
  • Request and validate user input
  • Launch $EDITOR to edit plain text and typed data
  • (TODO) Animated spinners (using tokio for async projects and std::thread otherwise)

Out of scope:

  • Non-UNIX platforms
  • Config file handling
  • Argument parsing (intended to be used alongside clap)
  • Progress bars (for now)
  • curses-style text user interface (TUI) painting to the terminal as a canvas

Initially, this library was written as an extension of termcolor, but now the functionality that was required has been absorbed / copied / rewritten. As such, some of the ideas and design are taken from there and credit is due.

Re-exports

pub use crate::core::Buffer;
pub use crate::core::Line;
pub use crate::core::Stream;
pub use crate::core::GetLine;
pub use input::Input;
pub use print::Print;
pub use style::Paint;
pub use style::Palette;
pub use style::Color;
pub use style::Tags;

Modules

core

Core functionality: dealing with buffers of colored terminal output

edit

Edit text using $EDITOR

input

User input

print

Multi-line text segments like Lists or Trees

style

Color Palette and Tags

term

Writing colored text to the terminal

Macros

edit_as_toml

Implement Editable for a type T: Serialize + DeserializeOwned

Structs

Claw

The main Conciliator implementor

List

List of things to print, with a short description

Tree

Tree structure of things to print, recursively traversed

Enums

Wrap

Wraps any Display type to be Inlined with the chosen Color

WrapBold

Wraps any Display type to be Inlined with the chosen Color but in bold

Traits

Conciliator

Convenient methods for printing user-facing messages

Inline

Display with colors

Functions

init

Initialize the main Conciliator implementor, Claw