mirror of
https://github.com/tauri-apps/tauri.git
synced 2026-04-07 10:22:29 +02:00
d623d95fcb
* fix(cli.rs): inliner dialoguer & console until they publish, fixes #1492 * fix tests * change file * fix: tests & fmt * chore: add fork note * fix: windows deps * chore(licensing): add note for console & dialoguer Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> Co-authored-by: Daniel Thompson-Yvetot <denjell@mailscript.com>
109 lines
3.3 KiB
Rust
109 lines
3.3 KiB
Rust
// Copyright 2019-2021 Tauri Programme within The Commons Conservancy
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
//! console is a library for Rust that provides access to various terminal
|
|
//! features so you can build nicer looking command line interfaces. It
|
|
//! comes with various tools and utilities for working with Terminals and
|
|
//! formatting text.
|
|
//!
|
|
//! Best paired with other libraries in the family:
|
|
//!
|
|
//! * [dialoguer](https://docs.rs/dialoguer)
|
|
//! * [indicatif](https://docs.rs/indicatif)
|
|
//!
|
|
//! # Terminal Access
|
|
//!
|
|
//! The terminal is abstracted through the `console::Term` type. It can
|
|
//! either directly provide access to the connected terminal or by buffering
|
|
//! up commands. A buffered terminal will however not be completely buffered
|
|
//! on windows where cursor movements are currently directly passed through.
|
|
//!
|
|
//! Example usage:
|
|
//!
|
|
//! ```
|
|
//! # fn test() -> Result<(), Box<dyn std::error::Error>> {
|
|
//! use std::thread;
|
|
//! use std::time::Duration;
|
|
//!
|
|
//! use console::Term;
|
|
//!
|
|
//! let term = Term::stdout();
|
|
//! term.write_line("Hello World!")?;
|
|
//! thread::sleep(Duration::from_millis(2000));
|
|
//! term.clear_line()?;
|
|
//! # Ok(()) } test().unwrap();
|
|
//! ```
|
|
//!
|
|
//! # Colors and Styles
|
|
//!
|
|
//! `console` uses `clicolors-control` to control colors. It also
|
|
//! provides higher level wrappers for styling text and other things
|
|
//! that can be displayed with the `style` function and utility types.
|
|
//!
|
|
//! Example usage:
|
|
//!
|
|
//! ```
|
|
//! use console::style;
|
|
//!
|
|
//! println!("This is {} neat", style("quite").cyan());
|
|
//! ```
|
|
//!
|
|
//! You can also store styles and apply them to text later:
|
|
//!
|
|
//! ```
|
|
//! use console::Style;
|
|
//!
|
|
//! let cyan = Style::new().cyan();
|
|
//! println!("This is {} neat", cyan.apply_to("quite"));
|
|
//! ```
|
|
//!
|
|
//! # Working with ANSI Codes
|
|
//!
|
|
//! The crate provids the function `strip_ansi_codes` to remove ANSI codes
|
|
//! from a string as well as `measure_text_width` to calculate the width of a
|
|
//! string as it would be displayed by the terminal. Both of those together
|
|
//! are useful for more complex formatting.
|
|
//!
|
|
//! # Unicode Width Support
|
|
//!
|
|
//! By default this crate depends on the `unicode-width` crate to calculate
|
|
//! the width of terminal characters. If you do not need this you can disable
|
|
//! the `unicode-width` feature which will cut down on dependencies.
|
|
//!
|
|
//! # Features
|
|
//!
|
|
//! By default all features are enabled. The following features exist:
|
|
//!
|
|
//! * `unicode-width`: adds support for unicode width calculations
|
|
//! * `ansi-parsing`: adds support for parsing ansi codes (this adds support
|
|
//! for stripping and taking ansi escape codes into account for length
|
|
//! calculations).
|
|
|
|
// Copyright 2019-2021 Tauri Programme within The Commons Conservancy
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
pub use kb::Key;
|
|
pub use term::{user_attended, user_attended_stderr, Term, TermFamily, TermFeatures, TermTarget};
|
|
pub use utils::{
|
|
colors_enabled, colors_enabled_stderr, measure_text_width, pad_str, pad_str_with,
|
|
set_colors_enabled, set_colors_enabled_stderr, style, truncate_str, Alignment, Attribute, Color,
|
|
Emoji, Style, StyledObject,
|
|
};
|
|
|
|
pub use ansi::{strip_ansi_codes, AnsiCodeIterator};
|
|
|
|
mod common_term;
|
|
mod kb;
|
|
mod term;
|
|
#[cfg(unix)]
|
|
mod unix_term;
|
|
mod utils;
|
|
#[cfg(target_arch = "wasm32")]
|
|
mod wasm_term;
|
|
#[cfg(windows)]
|
|
mod windows_term;
|
|
|
|
mod ansi;
|