mantono / giro

Rust crate to check if a directory belongs to a Git repository or not

giro

giro (from git-root) is a crate to for resolving the Git repository root directory, if any, of a path. So essentially, it enables you to find out two things:

• Does a path belong to a Git repository?
• If so, what is the root directory of this Git repository?

This crate only exposes one public function: 'git_root'

pub fn git_root<P: AsRef<std::path::Path>>(path: P) -> Result<Option<PathBuf>, std::io::Error>

Having this isolated functionality in a create means that other applications or crates may be able to use this crate over for example git2 or similar crates when they are only used for this functionality.

Usage

Library (crate)

Run

cargo add giro

or add

giro = "0.1"

to your projects Cargo.toml.

Then call it with

let root: Option<std::path::PathBuf> = giro::git_root("some/path")?;

Application (binary)

This will install giro as a git plugin. The binary will be installed as git-root.

cargo install giro

then run

git root

to check if the current directory is inside a git repository or not.

Man Pages

If you want man pages for the git-root binary, it can be added by copying the file git-root.1.man to a directory in your $MANPATH.

giro's Issues

Add -h/--help flag for binary

Make sure to document the different exit codes

Add example code in comment for git_root