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

use crate::{
    cli::cli::{Commit, VCS},
    commands::commit::executors::{
        execute_commit_breezy, execute_commit_dry_run, execute_commit_git,
        execute_commit_info, execute_commit_mercurial,
    },
    helpers::detect_vcs,
};

/// Defining an enum to represent the supported Commit Message Specifications:
///     * Angular
///     * Conventional
///     * None
///     * Unknown
pub enum CommitMessageFormat {
    Angular,
    Conventional,
    None,
    Unknown,
}

/// Executes the commit command with the given options
///
/// Arguments:
///
/// * `commit_options`: Struct that contains the options that were passed to the
///   command via user input (e.g. dry-run, info).
pub fn commit_command(commit_options: Commit) {
    if commit_options.dry_run {
        execute_commit_dry_run();
    } else if commit_options.info {
        execute_commit_info();
    } else {
        execute_commit();
    }
}

/// Detects the version control system, and then calls the appropriate
/// function to execute the commit
fn execute_commit() {
    let vcs = detect_vcs();

    match vcs {
        // Each executor checks to make sure there are staged files
        // before executing the commit command.
        // If there are no staged files, it logs a warning and exits.
        VCS::Git => execute_commit_git(),
        VCS::Mercurial => execute_commit_mercurial(),
        VCS::Breezy => execute_commit_breezy(),
    }
}