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
use std::fmt;
pub struct Error {
kind: ErrorKind,
context: Option<Box<dyn fmt::Display + Send + Sync>>,
commit: Option<String>,
}
impl Error {
pub(crate) fn new(kind: ErrorKind) -> Self {
Self {
kind,
context: None,
commit: None,
}
}
pub(crate) fn with_nom(commit: &str, err: nom::Err<nom::error::VerboseError<&str>>) -> Self {
use nom::error::VerboseErrorKind::*;
use ErrorKind::*;
let mut kind = InvalidFormat;
match err {
nom::Err::Incomplete(_) => unreachable!(),
nom::Err::Error(err) | nom::Err::Failure(err) => {
for (_input, context) in &err.errors {
kind = match context {
Context(string) => match *string {
crate::parser::SUMMARY => MissingType,
crate::parser::TYPE => MissingType,
crate::parser::SCOPE => InvalidScope,
crate::parser::DESCRIPTION => MissingDescription,
crate::parser::BODY => InvalidBody,
_ => kind,
},
_ => kind,
};
}
}
}
Self {
kind,
context: None,
commit: Some(commit.to_owned()),
}
}
pub(crate) fn set_context(mut self, context: Box<dyn fmt::Display + Send + Sync>) -> Self {
self.context = Some(context);
self
}
pub fn kind(&self) -> ErrorKind {
self.kind
}
}
impl fmt::Debug for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.debug_struct("Error")
.field("kind", &self.kind)
.field("context", &self.context.as_ref().map(|s| s.to_string()))
.field("commit", &self.commit)
.finish()
}
}
impl fmt::Display for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
if let Some(context) = self.context.as_ref() {
write!(f, "{}: {}", self.kind, context)
} else {
write!(f, "{}", self.kind)
}
}
}
impl std::error::Error for Error {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
None
}
}
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub enum ErrorKind {
MissingType,
InvalidScope,
MissingDescription,
InvalidBody,
InvalidFooter,
InvalidFormat,
}
impl fmt::Display for ErrorKind {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let s = match self {
ErrorKind::MissingType => {
"Missing type in the commit summary, expected `type: description`"
}
ErrorKind::InvalidScope => {
"Incorrect scope syntax in commit summary, expected `type(scope): description`"
}
ErrorKind::MissingDescription => {
"Missing description in commit summary, expected `type: description`"
}
ErrorKind::InvalidBody => "Incorrect body syntax",
ErrorKind::InvalidFooter => "Incorrect footer syntax",
ErrorKind::InvalidFormat => "Incorrect conventional commit format",
};
f.write_str(s)
}
}