1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
//! # reedline `\|/`
//! # A readline replacement written in Rust
//!
//! Reedline is a project to create a readline-style crate
//! for Rust that supports many of the modern conveniences of CLIs,
//! including syntax highlighting, completions, multiline support,
//! Unicode support, and more.
//!
//! ## Basic example
//!
//! ```rust,no_run
//! // Create a default reedline object to handle user input
//!
//! use reedline::{DefaultPrompt, Reedline, Signal};
//! use std::io;
//!
//! let mut line_editor = Reedline::create()?;
//! let prompt = DefaultPrompt::default();
//!
//! loop {
//! let sig = line_editor.read_line(&prompt);
//! match sig {
//! Ok(Signal::Success(buffer)) => {
//! println!("We processed: {}", buffer);
//! }
//! Ok(Signal::CtrlD) | Ok(Signal::CtrlC) => {
//! let _ = line_editor.print_crlf();
//! break;
//! }
//! Ok(Signal::CtrlL) => {
//! line_editor.clear_screen();
//! }
//! x => {
//! println!("Event: {:?}", x);
//! }
//! }
//! }
//! # Ok::<(), io::Error>(())
//! ```
//! ## Integrate with custom Keybindings
//!
//! ```rust,no_run
//! // Configure reedline with custom keybindings
//!
//! //Cargo.toml
//! // [dependencies]
//! // crossterm = "*"
//!
//! use std::io;
//! use {
//! crossterm::event::{KeyCode, KeyModifiers},
//! reedline::{default_emacs_keybindings, EditCommand, Reedline, Emacs, ReedlineEvent},
//! };
//!
//! let mut keybindings = default_emacs_keybindings();
//! keybindings.add_binding(
//! KeyModifiers::ALT,
//! KeyCode::Char('m'),
//! ReedlineEvent::Edit(vec![EditCommand::BackspaceWord]),
//! );
//! let edit_mode = Box::new(Emacs::new(keybindings));
//!
//! let mut line_editor = Reedline::create()?.with_edit_mode(edit_mode);
//! # Ok::<(), io::Error>(())
//! ```
//!
//! ## Integrate with custom History
//!
//! ```rust,no_run
//! // Create a reedline object with history support, including history size limits
//!
//! use std::io;
//! use reedline::{FileBackedHistory, Reedline};
//!
//! let history = Box::new(
//! FileBackedHistory::with_file(5, "history.txt".into())
//! .expect("Error configuring history with file"),
//! );
//! let mut line_editor = Reedline::create()?
//! .with_history(history)
//! .expect("Error configuring reedline with history");
//! # Ok::<(), io::Error>(())
//! ```
//!
//! ## Integrate with custom Highlighter
//!
//! ```rust,no_run
//! // Create a reedline object with highlighter support
//!
//! use std::io;
//! use reedline::{DefaultHighlighter, Reedline};
//!
//! let commands = vec![
//! "test".into(),
//! "hello world".into(),
//! "hello world reedline".into(),
//! "this is the reedline crate".into(),
//! ];
//! let mut line_editor =
//! Reedline::create()?.with_highlighter(Box::new(DefaultHighlighter::new(commands)));
//! # Ok::<(), io::Error>(())
//! ```
//!
//! ## Integrate with custom Tab-Handler
//!
//! ```rust,no_run
//! // Create a reedline object with tab completions support
//!
//! use std::io;
//! use reedline::{DefaultCompleter, DefaultCompletionActionHandler, Reedline};
//!
//! let commands = vec![
//! "test".into(),
//! "hello world".into(),
//! "hello world reedline".into(),
//! "this is the reedline crate".into(),
//! ];
//! let completer = Box::new(DefaultCompleter::new_with_wordlen(commands.clone(), 2));
//!
//! let mut line_editor = Reedline::create()?.with_completion_action_handler(Box::new(
//! DefaultCompletionActionHandler::default().with_completer(completer),
//! ));
//! # Ok::<(), io::Error>(())
//! ```
//!
//! ## Integrate with custom Hinter
//!
//! ```rust,no_run
//! // Create a reedline object with in-line hint support
//!
//! //Cargo.toml
//! // [dependencies]
//! // nu-ansi-term = "*"
//!
//! use std::io;
//! use {
//! nu_ansi_term::{Color, Style},
//! reedline::{DefaultCompleter, DefaultHinter, Reedline},
//! };
//!
//! let commands = vec![
//! "test".into(),
//! "hello world".into(),
//! "hello world reedline".into(),
//! "this is the reedline crate".into(),
//! ];
//! let completer = Box::new(DefaultCompleter::new_with_wordlen(commands.clone(), 2));
//!
//! let mut line_editor = Reedline::create()?.with_hinter(Box::new(
//! DefaultHinter::default()
//! .with_completer(completer) // or .with_history()
//! // .with_inside_line()
//! .with_style(Style::new().italic().fg(Color::LightGray)),
//! ));
//! # Ok::<(), io::Error>(())
//! ```
//!
//! ## Are we prompt yet? (Development status)
//!
//! This crate is currently under active development
//! in JT's [live-coding streams](https://www.twitch.tv/jntrnr).
//! If you want to see a feature, jump by the streams,
//! file an [issue](https://github.com/jntrnr/reedline/issues)
//! or contribute a [PR](https://github.com/jntrnr/reedline/pulls)!
//!
//! - [x] Basic unicode grapheme aware cursor editing.
//! - [x] Configurable prompt
//! - [x] Basic EMACS-style editing shortcuts.
//! - [x] Configurable keybindings.
//! - [x] Basic system integration with clipboard or optional stored history file.
//! - [x] Content aware highlighting.
//! - [x] Autocompletion.
//! - [x] Undo support.
//! - [x] Multiline aware editing with line completion validation.
//!
//! For a more detailed roadmap check out [TODO.txt](https://github.com/jntrnr/reedline/blob/main/TODO.txt).
//!
//! Join the vision discussion in the [vision milestone list](https://github.com/jntrnr/reedline/milestone/1) by contributing suggestions or voting.
//!
//! ### Alternatives
//!
//! For currently more mature Rust line editing check out:
//!
//! - [rustyline](https://crates.io/crates/rustyline)
#![warn(rustdoc::missing_crate_level_docs)]
#![warn(rustdoc::missing_doc_code_examples)]
#![warn(missing_docs)]
// #![deny(warnings)]
mod core_editor;
mod text_manipulation;
mod enums;
pub use enums::{EditCommand, ReedlineEvent, Signal};
mod painter;
mod engine;
pub use engine::Reedline;
mod history;
pub use history::{FileBackedHistory, History, HISTORY_SIZE};
mod prompt;
pub use prompt::{
DefaultPrompt, Prompt, PromptEditMode, PromptHistorySearch, PromptHistorySearchStatus,
PromptViMode, DEFAULT_PROMPT_COLOR, DEFAULT_PROMPT_INDICATOR,
};
mod edit_mode;
pub use edit_mode::{default_emacs_keybindings, EditMode, Emacs, Vi};
mod highlighter;
pub use highlighter::{DefaultHighlighter, Highlighter};
mod styled_text;
pub use styled_text::StyledText;
mod completion;
pub use completion::{
ComplationActionHandler, Completer, DefaultCompleter, DefaultCompletionActionHandler, Span,
};
mod hinter;
pub use hinter::{DefaultHinter, Hinter};
mod validator;
pub use validator::{DefaultValidator, ValidationResult, Validator};