scud_core 0.13.0

Core library of scud
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
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

use clap::{Args, Subcommand};

///////////////////////////////////
// Branch subcommands            //
//                               //
// 1. List all branches          //
//      (local and remote)       //
// 2. Rename a branch            //
// 3. Delete a branch            //
//      (local or remote)        //
///////////////////////////////////

/// Primary command for working with branches
/// within the context of scud in the current repository.
/// Handles listing, renaming, and deleting branches.
/// When passed no arguments, it will list all branches.
/// [alias: br]
#[derive(Debug, Args)]
#[clap(args_conflicts_with_subcommands = true)]
pub struct Branch {
    /// The subcommand to run.
    #[clap(subcommand)]
    pub command: Option<BranchCommands>,

    /// When true, will output the commands that scud runs under the hood
    ///
    /// (optional).
    /// [default: false]
    #[clap(short, long, value_parser, required = false, default_value_t = false)]
    pub info: bool,
}

/// The subcommands within scud's branch command surface (i.e. list, delete,
/// rename).
#[derive(Debug, Subcommand)]
pub enum BranchCommands {
    /// Renames a branch in the current repository.
    /// [alias: rn]
    #[clap(alias = "rn")]
    Rename(BranchRename),

    /// Deletes a branch in the current repository (local or remote).
    /// [alias: del]
    #[clap(alias = "del")]
    Delete(BranchDelete),
}

/// Lists all feature branches in the current local repository.
/// [alias: ]
#[derive(Debug, Args)]
pub struct BranchRename {
    /// When true, will output the commands that scud runs under the hood
    ///
    /// (optional).
    /// [default: false]
    #[clap(short, long, value_parser, required = false, default_value_t = false)]
    pub info: bool,
}

/// Delete a branch in the current repository.
/// CLI will ask if you want to delete remote or local and prompt for
/// confirmation before deleting the branch. [alias: d]
#[derive(Debug, Args)]
pub struct BranchDelete {
    /// When true, will output the commands that scud runs under the hood
    ///
    /// (optional).
    /// [default: false]
    #[clap(short, long, value_parser, required = false, default_value_t = false)]
    pub info: bool,
}

///////////////////////////////////
// Feature subcommands           //
//                               //
// 1. List all feature branches  //
// 2. Start a new feature branch //
// 3. Finish a feature branch    //
///////////////////////////////////

/// Provides feature branch functionality following the git-flow branching
/// model. Handles listing, starting, and finishing feature branches.
/// [alias: f]
#[derive(Debug, Args)]
#[clap(args_conflicts_with_subcommands = true)]
pub struct Feature {
    /// The subcommand to run.
    #[clap(subcommand)]
    pub command: Option<FeatureCommands>,
}

/// The subcommands within scud's feature command surface (i.e. list, start,
/// finish).
#[derive(Debug, Subcommand)]
pub enum FeatureCommands {
    /// Lists all feature branches in the current local repository.
    /// [alias: ls]
    #[clap(alias = "ls")]
    List(FeatureList),

    /// Starts a new feature branch in the current local repository.
    /// [alias: st]
    #[clap(alias = "st")]
    Start(FeatureStart),
    // /// Finishes the current feature branch in the current local repository.
    // /// [alias: fin]
    // #[clap(alias = "fin")]
    // Finish(Finish),
}

/// Lists all feature branches in the current local repository.
/// [alias: ls]
#[derive(Debug, Args)]
pub struct FeatureList {
    /// When true, will output the commands that scud runs under the hood
    ///
    /// (optional).
    /// [default: false]
    #[clap(short, long, value_parser, required = false, default_value_t = false)]
    #[clap(value_parser)]
    pub info: bool,
}

/// Starts a new feature branch in the current local repository.
#[derive(Debug, Args)]
pub struct FeatureStart {
    /// When true, will not start a feature branch but will show expected
    /// output. (optional).
    /// [default: false]
    #[clap(short, long, value_parser, required = false, default_value_t = false)]
    pub dry_run: bool,

    /// When true, will output the commands that scud runs under the hood
    ///
    /// (optional).
    /// [default: false]
    #[clap(short, long, value_parser, required = false, default_value_t = false)]
    #[clap(value_parser)]
    pub info: bool,
}