@antongolub/git-root

中文文档
1.5.14发布于 2024/07/06MITTypeScriptESM + CJS零依赖构建来源已验证近 30 天下载 3.1万

查找最接近的 . git 包含路径

中文使用文档
文档目录6 节
  1. 动机
  2. 特征
  3. 安装
  4. 使用量
  5. 替代品
  6. 许可证

@antongolub/git-root (英语)

寻找最接近的包含路径的.git – git 根.

CI Maintainability Test Coverage npm (scoped)

动机

以找到 gi根的最好方法而出名:

git rev-parse --show-toplevel

然而,如果 git 可执行文件或 child_process.exec 由于一些(安全原因?)原因不能使用,使用这种工具是可取的. 灵感来自 pkg 迪尔。 。 。 .

特征

  • 搜索 .git 在目录树上
  • 处理 gitdir: </some/path.git> 重定向
  • TS 和流打出框
  • 同步/同步方法

安装

yarn add @antongolub/git-root

使用量

import { gitRoot, gitRootSync } from '@antongolub/git-root'

// async
const gitRoot1 = await gitRoot('/optional/cwd/path/')

// sync
const gitRoot2 = gitRoot('/defaults/to/process/cwd/', true)

// sync too
const gitRoot3 = gitRoot.sync()

// `gitRootSync` is an alias for `gitRoot.sync`
const gitRoot4 = gitRootSync()

替代品

许可证

麻省理工学院

版本与发布记录

@antongolub/git-root 共发布 16 个版本,首次发布于 2021/02/01;过去 12 个月发布了 0 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.5.14latest2024/07/062 年前
1.5.132023/06/273 年前
1.5.122023/06/013 年前
1.5.112023/05/303 年前
1.5.102023/02/173 年前
1.5.92023/02/173 年前

关于 @antongolub/git-root 的常见问题

@antongolub/git-root 是什么?

查找最接近的 . git 包含路径

如何安装 @antongolub/git-root?

在项目目录运行 npm install @antongolub/git-root,或使用 pnpm add / yarn add / bun add。

@antongolub/git-root 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@antongolub/git-root 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@antongolub/git-root 可以商用吗?

@antongolub/git-root 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@antongolub/git-root 的下载量有多少?

根据 npm 官方下载统计,@antongolub/git-root 在 2026/10/06 – 2026/11/04 这 30 天内被下载 31,178 次,日均约 1,039 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@antongolub/git-root 还在维护吗?

最新版本 1.5.14 发布于 2024/07/06(2 年前);至今共发布 16 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/02/01。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。