sdoc 0.8.11

Framework for building custom CLIs around shell, scripts, and executables
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
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

use model::{Command, Dependency, DependencyType, Internal, Section};

pub mod edit;
pub mod editconfig;
pub mod help;
pub mod init;
pub mod node;
pub mod shell;
pub mod util;
pub mod view;

#[cfg(test)]
mod help_test;
#[cfg(test)]
mod shell_test;

pub fn edit_command() -> Command {
    Command {
        value: None,
        internal: Internal {
            execute: edit::execute,
            auto_complete: edit::auto_complete,
        },
        description: s!("Edit a command"),
        alias: Some(s!("e")),
        usage: Some(s!("<command>")),
        name: s!("edit"),
        min_args: Some(1),
        dependencies: Some(vec![
            Dependency {
                value: DependencyType::Envar(s!("EDITOR")),
                description: s!("Set this environment variable to the editor of your choice"),
            }]),
    }
}

pub fn help_command() -> Command {
    Command {
        value: None,
        internal: Internal {
            execute: help::execute,
            auto_complete: help::auto_complete,
        },
        description: s!("Show help for all commands or a specific command"),
        alias: Some(s!("h")),
        usage: Some(s!("[command]")),
        name: s!("help"),
        dependencies: None,
        min_args: None,
    }
}

pub fn view_command() -> Command {
    Command {
        value: None,
        internal: Internal {
            execute: view::execute,
            auto_complete: view::auto_complete,
        },
        description: s!("View a command"),
        alias: Some(s!("v")),
        usage: None,
        name: s!("view"),
        min_args: None,
        dependencies: None,
    }
}

pub fn edit_config_command() -> Command {
    Command {
        value: None,
        internal: Internal {
            execute: editconfig::execute,
            auto_complete: util::no_auto_complete,
        },
        description: s!("Edit configuration file"),
        alias: Some(s!("c")),
        usage: None,
        name: s!("config"),
        min_args: None,
        dependencies: Some(vec![
            Dependency {
                value: DependencyType::Envar(s!("EDITOR")),
                description: s!("Set this environment variable to the editor of your choice"),
            }]),
    }
}

pub fn get_management_commands() -> Section {
    Section {
        heading: s!("Management"),
        commands: vec![help_command(), edit_command(), view_command(), edit_config_command()],
        core: true
    }
}