mysh 0.1.8

Scaffolding to build interactive shells
Documentation 
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

use crate::{error::Error, CommandArg};
use colored::Colorize;
use futures::Future;
use serde_json::Value;

#[derive(Clone)]
pub struct DefaultArg;

impl CommandArg for DefaultArg {
  fn display_help() -> Vec<&'static str> {
    vec![]
  }
}

impl CommandArg for () {
  fn display_help() -> Vec<&'static str> {
    vec![]
  }
}

pub trait CommandMetadata<Info> {
  fn name(&self) -> &'static str;
  fn description(&self) -> &'static str;
  fn long_description(&self) -> Option<&'static str>;
  fn call_with_argv(
    &self,
    info: Info,
    argv: Vec<String>,
  ) -> Result<std::pin::Pin<Box<dyn Future<Output = Result<Value, Error>>>>, Error>;
  fn help(&self) -> Vec<&'static str>;

  fn print_help(&self) {
    let options = self.help();

    println!(
      "\n{}\n    {} {}",
      "Name:".bold(),
      self.name().bold(),
      if options.len() > 0 { "[OPTIONS]" } else { "" }
    );
    println!(
      "\n{}\n    {}\n",
      "Description:".bold(),
      self.long_description().unwrap_or(self.description())
    );
    if options.len() > 0 {
      println!("{}", "Options:".bold());
      for option in options {
        println!("    {}", option);
      }
    }
  }
}