git-sumi 0.3.0

Non-opinionated commit message linter
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

use super::{CommitParser, Config, ParsedCommit, SumiError};

pub struct ConventionalCommitParser;

impl CommitParser for ConventionalCommitParser {
    fn parse(&self, commit: &str, config: &Config) -> Result<ParsedCommit, SumiError> {
        let header = self.get_commit_header(commit)?;
        let (gitmoji, commit) = self.parse_and_remove_emoji(commit, config)?;
        // Parse the commit message sans gitmoji using the git_conventional crate.
        let conventional_commit = match git_conventional::Commit::parse(&commit) {
            Ok(commit) => commit,
            Err(err) => match err.kind() {
                git_conventional::ErrorKind::InvalidBody => {
                    return Err(SumiError::SeparateHeaderFromBody);
                }
                _ => {
                    return Err(err.into());
                }
            },
        };

        let footers = conventional_commit
            .footers()
            .iter()
            .map(|footer| footer.to_string())
            .collect::<Vec<String>>();

        let references = self.extract_references(&commit);

        let parsed_commit = ParsedCommit {
            header,
            gitmoji,
            commit_type: Some(conventional_commit.type_().to_string()),
            scope: conventional_commit.scope().map(|s| s.to_string()),
            description: conventional_commit.description().to_string(),
            body: conventional_commit.body().map(|s| s.to_string()),
            footers: Some(footers).filter(|f| !f.is_empty()),
            is_breaking: Some(conventional_commit.breaking()),
            breaking_description: conventional_commit
                .breaking_description()
                .map(|s| s.to_string()),
            references,
        };

        Ok(parsed_commit)
    }
}