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

mod json_writer;
mod md_writer;

use std::{result::Result as StdResult, str::FromStr};

use strum::{Display, EnumString};

pub use self::{json_writer::JsonWriter, md_writer::MarkdownWriter};
use crate::{clog::Clog, error::Result, sectionmap::SectionMap};

#[derive(Copy, Clone, PartialEq, Eq, Debug, Default, EnumString, Display)]
#[strum(ascii_case_insensitive)]
pub enum ChangelogFormat {
    Json,
    #[default]
    Markdown,
}

impl<'de> serde::de::Deserialize<'de> for ChangelogFormat {
    fn deserialize<D>(deserializer: D) -> StdResult<Self, D::Error>
    where
        D: serde::de::Deserializer<'de>,
    {
        let s = String::deserialize(deserializer)?;
        FromStr::from_str(&s).map_err(serde::de::Error::custom)
    }
}

/// A trait that allows writing the results of a `clog` run which can then be
/// written in an arbitrary format. The single required function
/// `write_changelog()` accepts a `clog::SectionMap` which can be thought of
/// similiar to a `clog` "AST" of sorts.
///
/// `clog` provides two default implementors of this traint,
/// `clog::fmt::MarkdownWriter` and `clog::fmt::JsonWriter` for writing Markdown
/// and JSON respectively
pub trait FormatWriter {
    /// Writes a changelog from a given `clog::SectionMap` which can be thought
    /// of as an "AST" of sorts
    fn write_changelog(&mut self, options: &Clog, section_map: &SectionMap) -> Result<()>;
}