tinychange 0.3.2

A tool for creating tiny changelogs on a fly!
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

use crate::config::CommandOpts;
use miette::{bail, miette};
use std::fmt::Display;
use std::hash::{Hash, Hasher};
use std::{fmt, hash};

#[derive(Debug, Clone, Hash)]
pub struct TinyChange {
    pub kind: String,
    pub message: String,
    pub author: String,
}

impl TinyChange {
    pub fn filename(&self, opts: &CommandOpts) -> miette::Result<String> {
        let hash = {
            let mut hasher = hash::DefaultHasher::new();
            self.hash(&mut hasher);
            hasher.finish()
        };

        Ok(format!(
            "{}.md",
            opts.naming().generate(hash, opts.max_filename_length())?
        ))
    }

    pub fn as_markdown(&self) -> MarkdownChange {
        MarkdownChange(self)
    }

    pub fn serialize(&self) -> String {
        format!(
            "- Author: {}\n- Kind: {}\n---\n{}",
            self.author, self.kind, self.message
        )
    }

    pub fn deserialize(opts: &CommandOpts, content: String) -> miette::Result<Self> {
        let mut lines = content.lines().peekable();

        let (field, author) = lines
            .next()
            .ok_or_else(|| miette!("Invalid format: Missing author field"))?
            .split_once(":")
            .ok_or_else(|| miette!("Invalid format: Malformed author field (missing colon)"))?;

        if field != "- Author" {
            bail!("Invalid format: Expected author field, got {}", field)
        }
        let author = author.trim().to_owned();

        while lines.peek().is_some_and(|line| line.is_empty()) {
            lines.next();
        }

        let (field, kind) = lines
            .next()
            .ok_or_else(|| miette!("Invalid format: Missing kind field"))?
            .split_once(":")
            .ok_or_else(|| miette!("Invalid format: Malformed kind field (missing colon)"))?;

        if field != "- Kind" {
            bail!("Invalid format: Expected kind field, got {}", field)
        }
        let kind = kind.trim().to_owned();

        while lines.peek().is_some_and(|line| line.is_empty()) {
            lines.next();
        }
        if lines.next() != Some("---") {
            bail!("Invalid format: missing message separator")
        }
        let message: String =
            normalize_line_endings::normalized(lines.collect::<Vec<_>>().join("\n").trim().chars())
                .collect();

        if author.is_empty() {
            bail!("Empty author field")
        }

        if kind.is_empty() {
            bail!("Empty kind field")
        }

        if message.is_empty() {
            bail!("Empty message field")
        }

        if !opts.categories().contains(&kind) {
            bail!("Unknown change type: {}", kind)
        }

        Ok(Self {
            kind,
            message,
            author,
        })
    }
}

pub struct MarkdownChange<'a>(&'a TinyChange);

impl Display for MarkdownChange<'_> {
    fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
        if !self.0.message.contains("\n") {
            write!(f, "- {} (by {})", self.0.message, self.0.author)?;
        } else {
            let msg = self
                .0
                .message
                .lines()
                .map(|line| format!("  {}", line))
                .collect::<Vec<_>>()
                .join("\n");
            write!(f, "- {}\n  By: {}", msg, self.0.author)?;
        }
        Ok(())
    }
}