# @cypress/commit-info 中文文档

规范地址：https://npmcn.com/package/%40cypress/commit-info/

版本：2\.2\.2
npm 元数据更新时间：2026-01-27T17:12:47.996Z
中文译文更新时间：2026-11-11T07:16:30.944Z
软件包许可：MIT

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

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

弃用说明：Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

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

- 包体积（解压后）：11.3 kB，5 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- Node.js 要求：\>=6
- 运行依赖：6 个
- 首次发布：2017-10-28T03:54:37.990Z
- 最新版本发布：2026-01-21T20:20:28.746Z
- 近 30 天下载量：51000（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：24（近 12 个月 1 个）

## 中文简介

收藏 CI或CLI提供的Git信息

## 安装

```sh
npm install @cypress/commit-info
```

也可以使用：`pnpm add @cypress/commit-info`、`yarn add @cypress/commit-info`、`bun add @cypress/commit-info`

## README

# @ cypress/ 承诺- info

> 收藏 Git 来自 git CLI 的信息

[![NPM](https://nodei.co/npm/@cypress/commit-info.svg?downloads=true)](https://npmjs.org/package/@cypress/commit-info)

 [![Build status](https://github.com/cypress-io/commit-info/actions/workflows/main.yml/badge.svg)](https://github.com/cypress-io/commit-info/actions/workflows/main.yml)[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg) ](https://github.com/semantic-release/semantic-release)[![renovate-app badge](https://img.shields.io/badge/renovate-app-blue.svg)](https://renovateapp.com/)

## 安装

要求数 [节点](https://nodejs.org/en/) 6或以上版本.

```sh
npm install --save @cypress/commit-info
```

## 使用

```js
const { commitInfo } = require('@cypress/commit-info')
// default folder is current working directory
commitInfo(folder)
  .then(info => {
    // info object will have properties
    // branch
    // message
    // email
    // author
    // sha
    // timestamp (in seconds since epoch)
    // remote
  })
```

注释:

-   代码假设 `.git` 文件夹并使用 Git 命令获取每个属性, 如 `git show -s --pretty=%B`,参见 [src/git-api.js (英语)](https://npmcn.com/package/%40cypress/commit-info/src/git-api.js)。注意:这可由环境变量所取代.
-   决定: [青鸟](https://github.com/petkaantonov/bluebird) 答应.
-   只使用 Git 命令, 参见 [src/git-api.js (英语)](https://npmcn.com/package/%40cypress/commit-info/src/git-api.js)
-   如果命令失败, 返回 `null` 每个财产
-   如果您需要调试, 请使用 `DEBUG=commit-info` 环境变量.

## 覆盖环境变量

如果使用 `git` 由于某种原因失败,或者想要覆盖它们,您可以通过设置环境变量来提供承诺信息. 此模块将查看以下环境变量作为后退

```
branch: COMMIT_INFO_BRANCH
message: COMMIT_INFO_MESSAGE
email: COMMIT_INFO_EMAIL
author: COMMIT_INFO_AUTHOR
sha: COMMIT_INFO_SHA
timestamp: COMMIT_INFO_TIMESTAMP
remote: COMMIT_INFO_REMOTE
```

### 嵌入容器

在 Docker 容器内运行应用程序时,您应该使用 `-e` 语法.

```shell
$ docker run \
  -e COMMIT_INFO_BRANCH=develop \
  -e COMMIT_INFO_SHA=e5d9eb66474bc0b681da9240aa5a457fe17bc8f3 \
  <container name>
```

见 [插件实例](https://npmcn.com/package/%40cypress/commit-info/docker-example) 一个完整的例子.

## 个别方法

何况 `commitInfo` 本单元还揭示了个人承诺的回归 方法 `getBranch`, (中文(简体) ), `getMessage`, (中文(简体) ), `getEmail`, (中文(简体) ), `getAuthor`, (中文(简体) ), `getSha`, (中文(简体) ), `getTimestamp`, (中文(简体) ), `getRemoteOrigin`。这些方法不使用倒置环境变量.

举个例子

```js
const {getAuthor} = require('@cypress/commit-info')
getAuthor('path/to/repo')
  .then(name => ...)
```

### 获取缓冲

以当前 git 分支名称或 `null`。 。 。 .

```js
const {getBranch} = require('@cypress/commit-info')
getBranch()
  .then(branch => ...)
```

-   如果这是分离的(报告) `HEAD`),返回时 `null`

### 小印数

许可:麻省理工学院 - 做任何与代码有关的事情, 但如果它不起作用,不要责怪我.

支持: 如果您发现此模块有任何问题, 电子邮件 / 微博 / [未决问题](https://github.com/cypress-io/commit-info/issues) 在基图布

## MIT 许可证

版权(c)2017 Cypress.io

特此免费准许任何人 获取该软件和相关文件的副本 文件(“软件”),在软件中处理,不包含 限制,包括不限制使用权, 复制、修改、合并、出版、发行、分版和/或销售 软件的复制本,并允许向 为此提供了软件,但须符合下列条件: 条件:

上述版权通知和本许可通知应为: 列入软件的所有副本或大部分.

软件是提供的"是", 没有任何种类的恐惧, 或监禁,包括但不限制于 特别目的和目的的证明 无所不入。 绝对不能让警察或警察 B. 任何索赔、救济或其他负债的持有者, 条约、条约或其他条约行动 来源、来源或与溶剂或使用有关的 其他交易 在软件.

## 常见问题

### @cypress/commit-info 是什么？

收藏 CI或CLI提供的Git信息注意：该包已被作者标记为弃用——Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

### 如何安装 @cypress/commit-info？

在项目目录运行 npm install @cypress/commit-info，或使用 pnpm add / yarn add / bun add。

### @cypress/commit-info 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/cypress\_\_commit-info 是否存在。

### @cypress/commit-info 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @cypress/commit-info 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=6。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @cypress/commit-info 可以商用吗？

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

### @cypress/commit-info 的下载量有多少？

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

### @cypress/commit-info 还在维护吗？

最新版本 2\.2\.2 发布于 2026/01/22（9 个月前）；至今共发布 24 个版本，其中过去 12 个月发布了 1 个；首次发布于 2017/10/28。作者已将其标记为弃用，新项目建议寻找替代方案。