commit-wizard 0.0.2

A lightweight CLI assistant for Conventional Commits, semantic versioning, and changelog automation.
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
141
142
143
144

mod code;
mod kind;

pub use code::ErrorCode;
pub use kind::ErrorKind;

use serde::Serialize;
use std::fmt;
use thiserror::Error;

#[derive(Debug, Clone, Serialize)]
pub struct ErrorContextEntry {
    pub key: String,
    pub value: String,
}

#[derive(Debug, Clone, Serialize)]
pub struct ErrorDetails {
    pub code: String,
    pub kind: String,
    pub message: String,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub context: Vec<ErrorContextEntry>,
}

impl ErrorDetails {
    pub fn context_from_vec_string(&mut self, vecs: Vec<(String, String)>) {
        self.context = vecs
            .into_iter()
            .map(|(k, v)| ErrorContextEntry { key: k, value: v })
            .collect();
    }

    pub fn context_as_map(&self) -> std::collections::BTreeMap<String, String> {
        self.context
            .iter()
            .map(|entry| (entry.key.clone(), entry.value.clone()))
            .collect()
    }
}

#[derive(Debug, Error)]
pub struct Error {
    pub code: ErrorCode,
    pub kind: ErrorKind,
    pub message: String,
    pub context: Vec<(String, String)>,
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{} ({}): {}", self.message, self.code, self.message)?;
        for (k, v) in &self.context {
            write!(f, "\n  {k}: {v}")?;
        }
        Ok(())
    }
}

impl Error {
    pub fn from_code(code: ErrorCode) -> Self {
        Self {
            kind: code.kind(),
            message: code.message().to_string(),
            code,
            context: Vec::new(),
        }
    }

    pub fn new(code: ErrorCode, message: impl Into<String>) -> Self {
        Self {
            kind: code.kind(),
            code,
            message: message.into(),
            context: Vec::new(),
        }
    }

    pub fn with_context(mut self, key: impl Into<String>, value: impl Into<String>) -> Self {
        self.context.push((key.into(), value.into()));
        self
    }

    pub fn with_context_str(
        mut self,
        key: impl Into<String>,
        value: impl std::fmt::Display,
    ) -> Self {
        self.context.push((key.into(), value.to_string()));
        self
    }

    pub fn exit_code(&self) -> i32 {
        self.code.exit_code()
    }

    pub fn details(&self) -> ErrorDetails {
        ErrorDetails {
            code: self.code.id(),
            kind: format!("{:?}", self.kind).to_lowercase(),
            message: self.message.clone(),
            context: self
                .context
                .iter()
                .map(|(key, value)| ErrorContextEntry {
                    key: key.clone(),
                    value: value.clone(),
                })
                .collect(),
        }
    }
}

impl ErrorCode {
    pub fn error(self) -> Error {
        Error::from_code(self)
    }
}

impl From<std::io::Error> for Error {
    fn from(err: std::io::Error) -> Self {
        ErrorCode::IoFailure
            .error()
            .with_context("error", err.to_string())
    }
}

impl From<toml::de::Error> for Error {
    fn from(err: toml::de::Error) -> Self {
        ErrorCode::ConfigInvalid
            .error()
            .with_context("error", err.to_string())
    }
}

impl From<serde_json::Error> for Error {
    fn from(err: serde_json::Error) -> Self {
        ErrorCode::SerializationFailure
            .error()
            .with_context("error", err.to_string())
    }
}

pub type Result<T> = std::result::Result<T, Error>;