# @cloud-ru/ft-config-commit-message 中文文档

规范地址：https://npmcn.com/package/%40cloud-ru/ft-config-commit-message/

版本：1\.1\.3
npm 元数据更新时间：2026-08-18T10:26:44.610Z
中文译文更新时间：2026-11-10T04:01:57.865Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40cloud-ru/ft-config-commit-message
原文对照：https://npmcn.com/package/%40cloud-ru/ft-config-commit-message/?lang=original
项目主页：https://github.com/cloud-ru-tech/frontend-tools/tree/master/packages/config-commit-message
源码仓库：https://github.com/cloud-ru-tech/frontend-tools

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

- 包体积（解压后）：48.1 kB，34 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2023-11-20T18:29:27.488Z
- 最新版本发布：2026-08-18T10:26:44.372Z
- 近 30 天下载量：2776（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 3 个）

## 中文简介

自动格式化的配置信件, 捆绑在 @ cloud- ru/ ft- config- husky

## 安装

```sh
npm install @cloud-ru/ft-config-commit-message
```

也可以使用：`pnpm add @cloud-ru/ft-config-commit-message`、`yarn add @cloud-ru/ft-config-commit-message`、`bun add @cloud-ru/ft-config-commit-message`

## README

# `@cloud-ru/ft-config-commit-message`

> {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢
> 
> {\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢

## 配置

说吧

-   `cloud-ru-commit-message` 对象在您的软件包中。json
-   `.cloudrucommitmessagerc` 以 JSON 或 YML 为格式的文件
-   `cloud-ru-commit-message.config.js` 以JS格式编写的文件

{\\fn黑体\\fs22\\bord1\\shad0\\3aHBE\\4aH00\\fscx67\\fscy66\\2cHFFFFFF\\3cH808080}你觉得呢 [宇宙图](https://github.com/davidtheclark/cosmiconfig)。 。 。 .

## 选项

```ts
type CloudRuCommitMessageConfig = {
  ticketPattern: string;
  ignoreMessagePrefix: string;
  forceConventional: boolean;
  forceTicket: boolean;
};

const defaultCloudRuCommitMessageConfig: CloudRuCommitMessageConfig = {
  ticketPattern: '([A-Z]+-\\d+)', //Ticket regexp, use default one, if you need cover Jira case
  ignoreMessagePrefix: '&', // Use this prefix for skip running validation and formatting (but ignoreMessagePrefix itself would be removed)
  forceConventional: false, // Commit creation will fail, if commit message format does not correspond to conventional commit
  forceTicket: false, // Commit creation will fail, if commit message either branch name do not contain ticket id
};
```

## 常见问题

### @cloud-ru/ft-config-commit-message 是什么？

自动格式化的配置信件, 捆绑在 @ cloud- ru/ ft- config- husky

### 如何安装 @cloud-ru/ft-config-commit-message？

在项目目录运行 npm install @cloud-ru/ft-config-commit-message，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 cloud-ru-commit-message，可以用 npx cloud-ru-commit-message 直接运行。

### @cloud-ru/ft-config-commit-message 支持 TypeScript 吗？

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

### @cloud-ru/ft-config-commit-message 支持 ESM 还是 CommonJS？

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

### @cloud-ru/ft-config-commit-message 可以商用吗？

@cloud-ru/ft-config-commit-message 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @cloud-ru/ft-config-commit-message 的下载量有多少？

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

### @cloud-ru/ft-config-commit-message 还在维护吗？

最新版本 1\.1\.3 发布于 2026/08/18（2 个月前）；至今共发布 13 个版本，其中过去 12 个月发布了 3 个；首次发布于 2023/11/21。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。