commando 1.1.0

An interactive CLI tool to help you write conventional commit messages with ease.
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

/// The template written to the temp file before the editor opens.
///
/// Comment lines (starting with #) are stripped after the editor closes.
/// Format follows conventional commits spec.
pub fn commit_template() -> &'static str {
    "\n
# --- commando — conventional commit ---
#
# Format:  type(scope)!: description
#
# Types:   feat  fix  docs  style  refactor  perf  test  build  ci  chore  revert
# Scope:   optional — alphanumeric, hyphens, underscores  e.g. (auth), (api)
# Breaking: add '!' before ':' AND/OR a 'BREAKING CHANGE: ...' footer
#
# --- Examples ---
# feat(auth): add OAuth 2.0 login
#
# Migrated from session-based auth to OAuth 2.0.
# All existing sessions will be invalidated on deploy.
#
# BREAKING CHANGE: session cookies are no longer valid after this release
# Refs: #142
# ---
# Lines starting with '#' are ignored.
# An empty message aborts the commit.
"
}

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

    #[test]
    fn template_is_non_empty() {
        assert!(!commit_template().is_empty());
    }

    #[test]
    fn template_lines_all_start_with_hash() {
        // Every line in the template is a comment — user starts writing below
        for line in commit_template().lines() {
            if !line.is_empty() {
                assert!(
                    line.starts_with('#'),
                    "Non-comment line in template: '{}'",
                    line
                );
            }
        }
    }

    #[test]
    fn template_mentions_all_types() {
        let t = commit_template();
        for kind in &[
            "feat", "fix", "docs", "style", "refactor", "perf", "test", "build", "ci", "chore",
            "revert",
        ] {
            assert!(t.contains(kind), "template missing type: {}", kind);
        }
    }
}