# @antongolub/git-root 中文文档

规范地址：https://npmcn.com/package/%40antongolub/git-root/

版本：1\.5\.14
npm 元数据更新时间：2024-07-06T10:19:42.085Z
中文译文更新时间：2026-11-06T06:58:24.371Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40antongolub/git-root
原文对照：https://npmcn.com/package/%40antongolub/git-root/?lang=original
项目主页：https://github.com/antongolub/git-root/#readme
源码仓库：https://github.com/antongolub/git-root

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：9.9 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2021-01-31T23:09:16.907Z
- 最新版本发布：2024-07-06T10:19:41.708Z
- 近 30 天下载量：31178（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 0 个）

## 中文简介

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

## 安装

```sh
npm install @antongolub/git-root
```

也可以使用：`pnpm add @antongolub/git-root`、`yarn add @antongolub/git-root`、`bun add @antongolub/git-root`

## README

# @antongolub/git-root (英语)

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

[![CI](https://github.com/antongolub/git-root/workflows/CI/badge.svg)](https://github.com/antongolub/git-root/actions) [![Maintainability](https://api.codeclimate.com/v1/badges/77d281e69a451680e1d1/maintainability)](https://codeclimate.com/github/antongolub/git-root/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/77d281e69a451680e1d1/test_coverage)](https://codeclimate.com/github/antongolub/git-root/test_coverage) [![npm (scoped)](https://img.shields.io/npm/v/@antongolub/git-root)](https://www.npmjs.com/package/@antongolub/git-root)

## 动机

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

```shell
git rev-parse --show-toplevel
```

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

## 特征

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

## 安装

```shell
yarn add @antongolub/git-root
```

## 使用量

```ts
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()
```

## 替代品

-   [寻找- 基特- 根](https://github.com/banyudu/find-git-root)
-   [基图](https://github.com/JPeer264/node-git-root)
-   [上层](https://github.com/royriojas/git-toplevel)
-   [基特 - 根 - 路径](https://github.com/VishnuTSuresh/git-root-path)

## 许可证

[麻省理工学院](https://npmcn.com/package/%40antongolub/git-root/LICENSE)

## 常见问题

### @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 和提交记录判断。