changelog 0.3.4

Changelog generator
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

use super::{Commit, Tag};
use std::str;

/// Format a list of commits to a changelog entry
#[must_use]
pub fn format(tag: &Tag, commits: &[Commit], repo_url: &str) -> String {
  let date = commits[0].datetime().naive_utc().date();
  let version = match tag.name() {
    Some(name) => name,
    None => "<unknown version>",
  };

  // Title
  let mut changelog = format!("## {}, Version {}\n", date, version);

  // Commits
  changelog.push_str("### Commits");
  for commit in commits {
    let long_hash = commit.hash();
    let short_hash = truncate(long_hash, 10);
    let url = format!("{}/commit/{}", repo_url, long_hash);
    let hash = format!("[`{}`]({})", short_hash, url);

    let msg: Vec<&str> = commit.message().split('\n').collect();
    let msg = msg[0];

    let author = match commit.author() {
      Some(author) => format!("({})", author),
      None => String::from(""),
    };

    let comm = format!("\n- [{}] {} {}", hash, msg, author);
    changelog.push_str(&comm);
  }

  changelog
}

/// Truncate a string to be max `n` chars long.
fn truncate(s: &str, max_chars: usize) -> &str {
  match s.char_indices().nth(max_chars) {
    None => s,
    Some((idx, _)) => &s[..idx],
  }
}

/// Get the stats section.
pub fn stats(diff: &str) -> crate::Result<String> {
  Ok(format!("\n\n### Stats\n```diff\n{}```\n", diff))
}