clean_git_history_lib 0.2.1

A Git history linter to ensure it stays clean for those who prefer rebasing and fast-forwarding compared to merge and squash commits.
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

use git2::{Oid, Repository};

pub(super) struct Commit {
    commit_hash: git2::Oid,
    number_of_parents: usize,
}

impl Commit {
    pub(super) fn from_git(repository: &Repository, oid: Oid) -> Result<Self, git2::Error> {
        let commit = repository.find_commit(oid)?;
        let number_of_parents = commit.parents().len();
        trace!(
            "The commit with the hash '{}' has {:?} parents.",
            commit.id(),
            number_of_parents,
        );

        Ok(Commit {
            commit_hash: commit.id(),
            number_of_parents,
        })
    }

    pub(super) fn is_merge_commit(&self) -> bool {
        let is_merge_commit = self.number_of_parents > 1;

        if is_merge_commit {
            warn!("Commit {:?} is a merge commit.", self.commit_hash);
        }

        is_merge_commit
    }
}

#[cfg(test)]
mod tests;