mkcmt 0.2.2

mkcmt is make commit. Conventional Commit Generator
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

/// The `changelog` module contains metadata about commit types, scopes, and the breaking change marker.

/// Allowed commit types.
pub const TYPES: &[&str] = &[
    "feat",     // new features
    "fix",      // bug fixes
    "docs",     // documentation only changes
    "style",    // formatting and style changes
    "refactor", // code refactoring
    "test",     // tests additions or fixes
    "chore",    // maintenance tasks
];

/// Allowed scopes (e.g., modules or subsystems).
pub const SCOPES: &[&str] = &["core", "ui", "api", "build", "docs", "tests"];

/// Marker that indicates a breaking change in the commit message footer.
pub const BREAKING_CHANGE_MARKER: &str = "!";

/// A structure representing the complete changelog metadata.
#[derive(Debug)]
pub struct Changelog {
    pub types: &'static [&'static str],
    pub scopes: &'static [&'static str],
    pub breaking_marker: &'static str,
}

/// Returns the changelog metadata.
pub fn get_changelog() -> Changelog {
    Changelog {
        types: TYPES,
        scopes: SCOPES,
        breaking_marker: BREAKING_CHANGE_MARKER,
    }
}

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

    #[test]
    fn test_changelog_contents() {
        let changelog = get_changelog();
        assert!(changelog.types.contains(&"feat"));
        assert!(changelog.scopes.contains(&"ui"));
        assert_eq!(changelog.breaking_marker, "!");
    }
}