cclog 0.12.0

A conventional changelog for the rest of us
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

use std::{collections::HashMap, path::PathBuf};

use indexmap::IndexMap;
use serde::Deserialize;

use crate::{fmt::ChangelogFormat, link_style::LinkStyle};

#[derive(Debug, Clone, Deserialize)]
pub struct RawCfg {
    pub clog: RawClogCfg,
    #[serde(default)]
    pub sections: IndexMap<String, Vec<String>>,
    #[serde(default)]
    pub components: HashMap<String, Vec<String>>,
}
#[derive(Debug, Clone, Default, Deserialize)]
#[serde(default, rename_all = "kebab-case")]
pub struct RawClogCfg {
    pub changelog: Option<String>,
    pub from_latest_tag: bool,
    pub repository: Option<String>,
    pub infile: Option<String>,
    pub subtitle: Option<String>,
    pub outfile: Option<String>,
    pub git_dir: Option<PathBuf>,
    pub git_work_tree: Option<PathBuf>,
    pub link_style: LinkStyle,
    pub output_format: ChangelogFormat,
}

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

    #[test]
    fn from_config() {
        let cfg = include_str!("../examples/clog.toml");
        let res = toml::from_str(cfg);
        assert!(res.is_ok(), "{res:?}");
        let cfg: RawCfg = res.unwrap();

        assert_eq!(
            cfg.clog.repository,
            Some("https://github.com/clog-tool/clog-lib".into())
        );
        assert_eq!(cfg.clog.subtitle, Some("my awesome title".into()));
        assert_eq!(cfg.clog.link_style, LinkStyle::Github);
        assert_eq!(cfg.clog.changelog, Some("mychangelog.md".into()));
        assert_eq!(cfg.clog.outfile, Some("MyChangelog.md".into()));
        assert_eq!(cfg.clog.infile, Some("My_old_changelog.md".into()));
        assert_eq!(cfg.clog.output_format, ChangelogFormat::Json);
        assert_eq!(cfg.clog.git_work_tree, Some("/myproject".into()));
        assert_eq!(cfg.clog.git_dir, Some("/myproject/.git".into()));
        assert!(cfg.clog.from_latest_tag);
        assert_eq!(
            cfg.sections.get("MySection"),
            Some(&vec!["mysec".into(), "ms".into()])
        );
        assert_eq!(
            cfg.sections.get("Another Section"),
            Some(&vec!["another".into()])
        );
        assert_eq!(
            cfg.components.get("MyLongComponentName"),
            Some(&vec!["long".into(), "comp".into()])
        );
    }

    #[test]
    fn dogfood_config() {
        let cfg = include_str!("../../.clog.toml");
        let res = toml::from_str(cfg);
        assert!(res.is_ok(), "{res:?}");
        let cfg: RawCfg = res.unwrap();

        assert_eq!(
            cfg.clog.repository,
            Some("https://github.com/clog-tool/clog-lib".into())
        );
        assert_eq!(cfg.clog.link_style, LinkStyle::Github);
        assert!(cfg.clog.from_latest_tag);
    }
}