3 个版本

0.1.2 2023 年 3 月 26 日
0.1.1 2023 年 3 月 12 日
0.1.0 2023 年 3 月 6 日

文件系统 中排名第 1539

MIT 许可证

6KB
78 代码行

giro

giro (来自 git-root) 是一个用于解决路径的 Git 仓库根目录(如果有的话)的 crate。因此,它本质上允许您找出两件事

  • 路径是否属于 Git 仓库?
  • 如果是,这个 Git 仓库的根目录是什么?

这个 crate 仅公开了一个公共函数:'git_root'

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

在 crate 中将此隔离功能意味着其他应用程序或 crate 可以在需要此功能时使用此 crate,而不是例如 git2 或类似的 crate。

使用方法

库(crate)

运行

cargo add giro

或将

giro = "0.1"

添加到您的项目 Cargo.toml。

然后使用以下命令调用它

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

应用程序(二进制文件)

这将安装 giro 作为 git 插件。二进制文件将安装为 git-root

cargo install giro

然后运行

git root

来检查当前目录是否在 Git 仓库内。

手册页面

如果您想为 git-root 二进制文件添加手册页面,可以将文件 git-root.1.man 复制到您的 $MANPATH 中的一个目录。

无运行时依赖