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

use cargo_metadata::camino::Utf8Path;

use crate::Result;

#[cfg(feature = "vcs-git")]
mod git;

pub(crate) fn discover(path: impl AsRef<Utf8Path>) -> Result<Option<Box<dyn Vcs>>> {
    let path = path.as_ref();

    // suppress unused variable warning
    let _ = path;

    #[cfg(feature = "vcs-git")]
    if let Some(vcs) = git::Git::discover(path)? {
        return Ok(Some(Box::new(vcs)));
    }

    Ok(None)
}

pub(crate) trait Vcs {
    fn workdir(&self) -> Option<&Utf8Path>;
    fn status_file(&self, path: &Utf8Path) -> Result<Status>;
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[allow(dead_code)]
pub(crate) enum Status {
    Dirty,
    Staged,
    Clean,
}