homeboy 0.76.0

CLI for multi-component deployment and development workflow 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

use crate::component::{self, Component};
use crate::project;

pub(super) const DEFAULT_NEXT_SECTION_LABEL: &str = "Unreleased";
pub(super) const DEFAULT_NEXT_SECTION_ALIASES: &[&str] = &["Unreleased", "Next"];

pub(super) const KEEP_A_CHANGELOG_SUBSECTIONS: &[&str] = &[
    "### Added",
    "### Changed",
    "### Deprecated",
    "### Removed",
    "### Fixed",
    "### Security",
];

pub(super) const VALID_ENTRY_TYPES: &[&str] = &[
    "added",
    "changed",
    "deprecated",
    "removed",
    "fixed",
    "security",
    "refactored",
];

#[derive(Debug, Clone)]
pub struct EffectiveChangelogSettings {
    pub next_section_label: String,
    pub next_section_aliases: Vec<String>,
}

pub fn resolve_effective_settings(component: Option<&Component>) -> EffectiveChangelogSettings {
    let project_settings = component
        .and_then(|c| component::projects_using(&c.id).ok())
        .and_then(|projects| {
            if projects.len() == 1 {
                project::load(&projects[0]).ok()
            } else {
                None
            }
        });

    let next_section_label = component
        .and_then(|c| c.changelog_next_section_label.clone())
        .or_else(|| {
            project_settings
                .as_ref()
                .and_then(|p| p.changelog_next_section_label.clone())
        })
        .unwrap_or_else(|| DEFAULT_NEXT_SECTION_LABEL.to_string());

    let mut next_section_aliases = component
        .and_then(|c| c.changelog_next_section_aliases.clone())
        .or_else(|| project_settings.and_then(|p| p.changelog_next_section_aliases.clone()))
        .unwrap_or_default();

    if next_section_aliases.is_empty() {
        for alias in DEFAULT_NEXT_SECTION_ALIASES {
            next_section_aliases.push((*alias).to_string());
        }
    }

    let mut ensure_alias = |alias: &str| {
        if !next_section_aliases
            .iter()
            .any(|existing| existing.trim().eq_ignore_ascii_case(alias.trim()))
        {
            next_section_aliases.push(alias.to_string());
        }
    };

    for alias in DEFAULT_NEXT_SECTION_ALIASES {
        ensure_alias(alias);
        ensure_alias(&format!("[{}]", alias));
    }

    ensure_alias(&next_section_label);
    ensure_alias(&format!("[{}]", next_section_label));

    EffectiveChangelogSettings {
        next_section_label,
        next_section_aliases,
    }
}

pub(super) fn validate_entry_type(entry_type: &str) -> crate::error::Result<String> {
    use crate::error::Error;
    let normalized = entry_type.to_lowercase();
    // Accept "refactor" as alias for "refactored"
    let normalized = if normalized == "refactor" {
        "refactored".to_string()
    } else {
        normalized
    };
    if VALID_ENTRY_TYPES.contains(&normalized.as_str()) {
        Ok(normalized)
    } else {
        Err(Error::validation_invalid_argument(
            "type",
            format!(
                "Invalid changelog entry type '{}'. Valid types: Added, Changed, Deprecated, Removed, Fixed, Security, Refactored",
                entry_type
            ),
            None,
            Some(vec![
                "Use --type added for new features".to_string(),
                "Use --type fixed for bug fixes".to_string(),
                "Use --type changed for modifications".to_string(),
                "Use --type refactored for code restructuring".to_string(),
            ]),
        ))
    }
}

pub(super) fn subsection_header_from_type(entry_type: &str) -> String {
    let capitalized = entry_type
        .chars()
        .next()
        .map(|c| c.to_uppercase().collect::<String>())
        .unwrap_or_default()
        + &entry_type[1..];
    format!("### {}", capitalized)
}

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

    #[test]
    fn defaults_include_unreleased_and_next_aliases() {
        let settings = resolve_effective_settings(None);
        let aliases = settings.next_section_aliases;

        assert!(aliases.iter().any(|a| a == "Unreleased"));
        assert!(aliases.iter().any(|a| a == "[Unreleased]"));
        assert!(aliases.iter().any(|a| a == "Next"));
        assert!(aliases.iter().any(|a| a == "[Next]"));
    }
}