nextsv 0.19.30

Next semantic version calculator
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

//! Error types for nextsv

use std::ffi::OsString;

use proc_exit::{Code, Exit};
use thiserror::Error;

pub const EXIT_UNEXPECTED_ERROR: i32 = 10;
pub const EXIT_NOT_CALCULATED_CODE: i32 = 12;
pub const EXIT_MISSING_REQUIRED_CODE: i32 = 13;
// pub const EXIT_NOT_REQUIRED_LEVEL: i32 = 14;
pub const EXIT_NO_FILES_LISTED: i32 = 15;

/// The error type for nextsv.
#[non_exhaustive]
#[derive(Error, Debug)]
pub enum Error {
    /// The tag provided is not a version tag as it does not
    /// start with the provided prefix string.
    #[error("Version tags must start with \"{0}\" but tag is {1}")]
    NotVersionTag(String, String),
    /// Too many components found.
    #[error("Version must have three components but at least {0} were found")]
    TooManyComponents(usize),
    /// Too few components found.
    #[error("Version must have three components but only {0} found")]
    TooFewComponents(usize),
    /// The component must be a digit
    #[error("Version must be a number but found {0}")]
    MustBeNumber(String),
    /// No valid version tag was found in the repository
    #[error("No valid version tag found in the repository")]
    NoVersionTag,
    /// The first production release (1.0.0) has already been made
    #[error("First production release already deployed. Current major version: {0}")]
    MajorAlreadyUsed(String),
    /// No conventional commits in the VersionCalculator struct
    #[error("No conventional commits have been loaded into the VersionCalculator struct. May have been called before `commits`.")]
    NoConventionalCommits,
    /// Missing required file found.
    #[error("Missing the required file(s): {0:?}.")]
    MissingRequiredFile(Vec<OsString>),
    /// Not a valid Type Hierarchy name.
    #[error("{0} is not a valid type hierarchy name.")]
    NotTypeHierarchyName(String),
    /// Corrupt version check regex. Check the `prefix` value.
    #[error("Version check regex error {0}. Check the `prefix` value.")]
    CorruptVersionRegex(regex::Error),
    /// List of files has not been generated yet (or there are no commits). Call `commits`
    /// to generate the list by walking back to the current version tag.
    #[error("No files have been listed. May have been called before `commits`.")]
    NoFilesListed,
    //
    // TODO: make use of these codes again by providing an option to use exit codes in the
    // CLI and to enable the use of the exit codes as an alternative to "breaking" a dependant
    // programme by providing an output that it cannot understand ("none")
    //
    // /// The minimum change level set for check has been met.
    // #[error("Minimum change Level has been met.")]
    // MinimumChangeLevelMet,
    // /// The minimum change level set for check has not been met.
    // #[error("Minimum change level has not been met.")]
    // MinimumChangeLevelNotMet,
    /// Error passed up from git2
    #[error("0:?")]
    Git2(#[from] git2::Error),
    /// Error passed up from convert TryFrom
    #[error("0:?")]
    TryFromIntError(#[from] std::num::TryFromIntError),
    /// Error passed up from cargo_toml
    #[error("cargo_toml error says: {0:?}")]
    Toml(#[from] cargo_toml::Error),
    /// Error passed up from regex
    #[error("regex error says: {0:?}")]
    Regex(#[from] regex::Error),
}

impl From<Error> for Exit {
    /// Convert select error codes into an exit code to allow a calling application to exit
    /// with an error code instead of handling the error.
    fn from(err: Error) -> Self {
        match err {
            Error::Git2(_) => {
                Exit::new(Code::new(EXIT_NOT_CALCULATED_CODE)).with_message(err.to_string())
            }
            Error::MissingRequiredFile(_) => {
                Exit::new(Code::new(EXIT_MISSING_REQUIRED_CODE)).with_message(err.to_string())
            }
            Error::NoFilesListed => {
                Exit::new(Code::new(EXIT_NO_FILES_LISTED)).with_message(err.to_string())
            }
            // Error::MinimumChangeLevelMet => Exit::new(Code::SUCCESS).with_message(err.to_string()),
            // Error::MinimumChangeLevelNotMet => {
            //     Exit::new(Code::new(EXIT_NOT_REQUIRED_LEVEL)).with_message(err.to_string())
            // }
            _ => Exit::new(Code::new(EXIT_UNEXPECTED_ERROR)),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_constants() {
        assert_eq!(EXIT_UNEXPECTED_ERROR, 10);
        assert_eq!(EXIT_NOT_CALCULATED_CODE, 12);
        assert_eq!(EXIT_MISSING_REQUIRED_CODE, 13);
        // assert_eq!(EXIT_NOT_REQUIRED_LEVEL, 14);
        assert_eq!(EXIT_NO_FILES_LISTED, 15);
    }
}