tome-scripts 0.12.3

Turn directories of shell scripts into full-blown CLIs
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67

use clap::{Args, Parser, Subcommand};

#[derive(Debug, Parser)]
#[clap(author, version, about, long_about = None)]
pub struct TomeArgs {
    #[clap(subcommand)]
    pub commands: TomeCommands,
}

#[derive(Debug, Subcommand)]
pub enum TomeCommands {
    // if we use "Help" directly, this
    // subcommand is overshaddowed by clap's own help
    // command. Therefore this is named CommandHelp
    CommandHelp(HelpArgs),
    CommandComplete(CompleteArgs),
    CommandExecute(ExecuteArgs),
    Init(InitArgs),
    /// find a script and exec it.
    /// run will not run the script in completion mode,
    /// regardless of the script front matter. builtins such as
    /// help are not accessible via this command
    Run(RunArgs),
}

#[derive(Debug, Args)]
pub struct CompleteArgs {
    pub command_directory_path: String,
    /// The type of the shell that is invoking completion
    #[clap(short, long)]
    pub shell: String,
    #[clap(last = true)]
    pub args: Vec<String>,
}

#[derive(Debug, Args)]
pub struct ExecuteArgs {
    pub command_directory_path: String,
    #[clap(short, long)]
    pub shell: String,
    #[clap(last = true)]
    pub args: Vec<String>,
}

#[derive(Debug, Args)]
pub struct HelpArgs {
    pub command_directory_path: String,
    #[clap(last = true)]
    pub args: Vec<String>,
}

#[derive(Debug, Args)]
pub struct InitArgs {
    /// The name for the generated command.
    pub command_name: String,
    /// The path to the directory that contains the commands to load.
    pub command_directory_path: String,
    /// The type of the shell to use, or the path to the shell executable being used.
    pub shell_type_or_path: String,
}

#[derive(Debug, Args)]
pub struct RunArgs {
    pub command_directory_path: String,
    #[clap(last = true)]
    pub args: Vec<String>,
}