cargo-sync-rdme 0.5.0

Cargo subcommand to synchronize README with crate documentation
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

use cargo_metadata::camino::Utf8Path;

use super::{Status, Vcs};
use crate::Result;

pub(super) struct Git {
    repo: git2::Repository,
}

impl Git {
    pub(super) fn discover(path: impl AsRef<Utf8Path>) -> Result<Option<Self>> {
        let path = path.as_ref();

        let repo = match git2::Repository::discover(path) {
            Ok(repo) => repo,
            Err(err) if err.code() == git2::ErrorCode::NotFound => return Ok(None),
            Err(err) => bail!(err),
        };
        Ok(Some(Self { repo }))
    }
}

impl Vcs for Git {
    fn workdir(&self) -> Option<&Utf8Path> {
        self.repo
            .workdir()
            .map(|path| <&Utf8Path>::try_from(path).unwrap())
    }

    fn status_file(&self, path: &Utf8Path) -> Result<Status> {
        let status = match self.repo.status_file(path.as_ref()) {
            Ok(status) => status,
            Err(err) if err.code() == git2::ErrorCode::NotFound => {
                // treat untracked files as dirty
                return Ok(Status::Dirty);
            }
            Err(err) => bail!(err),
        };

        if status.is_wt_new()
            || status.is_wt_modified()
            || status.is_wt_deleted()
            || status.is_wt_renamed()
            || status.is_wt_typechange()
        {
            return Ok(Status::Dirty);
        }

        if status.is_index_new()
            || status.is_index_modified()
            || status.is_index_deleted()
            || status.is_index_renamed()
            || status.is_index_typechange()
        {
            return Ok(Status::Staged);
        }

        Ok(Status::Clean)
    }
}