rustyrepl 0.2.0

// Copyright (c) Sean Lawlor
//
// This source code is licensed under the MIT license found in the
// LICENSE file in the root directory of this source tree.

//! rustyrepl is a simple read, evaluate, print, loop processor based on [clap] and utilizing
//! [rustyline].
//!
//! You simply need to define your command structure in a [clap::Parser] derived
//! struct and the processing logic, and the Repl will handle
//!
//! # Purpose
//!
//! 1. Capturing exits/quits of the REPL interface
//! 2. Storing and managing REPL history commands as well as an index of said commands for you
//! 3. Allowing operators to get a help menu at any point, using the full Clap supported help interface (i.e. sub-command help as well)
//! 4. Processing the commands as incoming
//!
//! # Usage
//!
//! First, add rustyrepl to your Cargo.toml file
//!
//! ```toml
//! [dependencies]
//! rustyrepl = "0.2"
//! ```
//!
//! Next:
//!
//! ```rust
//! use anyhow::Result;
//! use clap::{Parser, Subcommand};
//! use rustyrepl::{Repl, ReplCommandProcessor};
//!
//! /// The enum of sub-commands supported by the CLI
//! #[derive(Subcommand, Clone, Debug)]
//! pub enum Command {
//!     /// Execute a test command
//!     Test,
//! }
//!
//! /// The general CLI, essentially a wrapper for the sub-commands [Command]
//! #[derive(Parser, Clone, Debug)]
//! pub struct Cli {
//!     #[clap(subcommand)]
//!     command: Command,
//! }
//!
//! #[derive(Debug)]
//! pub struct CliProcessor {}
//!
//! #[async_trait::async_trait]
//! impl ReplCommandProcessor<Cli> for CliProcessor {
//!     fn is_quit(&self, command: &str) -> bool {
//!         matches!(command, "quit" | "exit")
//!     }
//!
//!     async fn process_command(&self, command: Cli) -> Result<()> {
//!         match command.command {
//!             Command::Test => println!("A wild test appeared!"),
//!         }
//!         Ok(())
//!     }
//! }
//!
//! // MAIN //
//! #[tokio::main]
//! async fn main() -> Result<()> {
//!     let processor: Box<dyn ReplCommandProcessor<Cli>> = Box::new(CliProcessor {});
//!
//!     let mut repl = Repl::<Cli>::new(processor, None, Some(">>".to_string()))?;
//!     repl.process().await
//! }
//! ```
//!
//! This small program will startup up a REPL with the prompt ">>" which you can interact with
//!
//! ```text
//! >> help
//! The general CLI, essentially a wrapper for the sub-commands [Commands]
//!
//! Usage: repl-interface <COMMAND>
//!
//! Commands:
//!   test  Execute a test command
//!   help  Print this message or the help of the given subcommand(s)
//!
//! Options:
//!   -h, --help  Print help
//!
//! ```

mod commands;
mod repl;

#[cfg(test)]
pub(crate) mod common_test;

pub use crate::commands::ReplCommandProcessor;
pub use crate::repl::Repl;