commitlint
18,811
Stars
980
Forks
62
Watchers
87
Open Issues
MIT
许可证
TypeScript
语言
2016-02-12
创建时间
2026-11-10
最近更新
项目能做什么
用于检查和规范 Git commit 提交信息的校验工具。
来源：基于仓库元数据
· 内容以仓库实际 README 为准
使用说明 查看原始 README 原仓库文档
中文使用说明暂未生成。下面保留原仓库 README 摘录，命令与配置均以原文为准。
原始 README 摘录（英文原文，节选前 3000 字符）
# [Get Started](https://commitlint.js.org/guides/getting-started) | [Website](https://commitlint.js.org)
> Lint commit messages
<p align="center">
<img width="600" src="docs/public/assets/commitlint.svg">
</p>
> Demo generated with [svg-term-cli](https://github.com/marionebl/svg-term-cli)
>
> `cat docs/assets/commitlint.json | svg-term --out docs/public/assets/commitlint.svg --frame --profile=Seti --height=20 --width=80`
[![npm latest][2]][3] [![node compatibility][13]][14] [![Github Actions][4]][5]
- 🚓 Be a good `commitizen`
- 📦 Share configuration via `npm`
- 🤖 Tap into `conventional-changelog`
## Contents
- [Get Started | Website](#get-started--website)
- [Contents](#contents)
- [What is commitlint](#what-is-commitlint)
- [Benefits of using commitlint](#benefits-of-using-commitlint)
- [Getting started](#getting-started)
- [CLI](#cli)
- [Config](#config)
- [Shared configuration](#shared-configuration)
- [Documentation](#documentation)
- [API](#api)
- [Tools](#tools)
- [Roadmap](#roadmap)
- [Version Support and Releases](#version-support-and-releases)
- [Releases](#releases)
- [Related projects](#related-projects)
- [License](#license)
- [Development](#development)
- [Install and run](#install-and-run)
---
## What is commitlint
commitlint checks if your commit messages meet the [conventional commit format](https://conventionalcommits.org).
In general the pattern mostly looks like this:
```sh
type(scope?): subject #scope is optional; multiple scopes are supported (current delimiter options: "/", "\" and ",")
```
Real world examples can look like this:
```text
chore: run tests on travis ci
```
```text
fix(server): send cors headers
```
```text
feat(blog): add comment section
```
Common types according to [commitlint-config-conventional (based on the Angular convention)](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional#type-enum) can be:
- build
- chore
- ci
- docs
- feat
- fix
- perf
- refactor
- revert
- style
- test
These can be modified by [your own configuration](#config).
### Benefits of using commitlint
- [Why Use Conventional Commits?](https://www.conventionalcommits.org/en/v1.0.0-beta.2/#why-use-conventional-commits)
- ["The perks of committing with conventions" (Talk slides)](https://slides.com/marionebl/the-perks-of-committing-with-conventions#/)
## Getting started
- [Local setup](https://commitlint.js.org/guides/local-setup) - Lint messages on commit with husky
- [CI setup](https://commitlint.js.org/guides/ci-setup) - Lint messages during CI builds
## CLI
- Primary way to interact with commitlint.
- `npm install --save-dev @commitlint/cli`
- Packages: [cli](./@commitlint/cli)
## Config
- Configuration is picked up from:
- `.commitlintrc`
- `.commitlintrc.json`
- `.commitlintrc.yaml`
- `.commitlintrc.yml`
- `.commitlintrc.js`
- `.commitlintrc.cjs`
- `.commitlintrc.mjs`
- `.commitlintrc.ts`
- `.commitlint
阅读完整原文
商业机会分析 规则生成（AI 未配置）
综合评分 64.9 分。该项目在“个人可实施性”维度得 57 分，“付费可能性”维度得 60.0 分，差异化空间 82.0 分（评分依据见评分卡）。
将 commitlint 改造为垂直场景 SaaS
| 产品构想 | 保留核心能力，针对某一类用户（如某行业团队）做托管版，收取月费。 |
| 目标用户 | 有该需求的中小团队 / 独立站长 |
| 难度/周期 | 中 · 2~4 周（MVP） |
| 收费模式 | 订阅制（如 ¥29~99/月） |
| 竞争风险 | 需验证付费意愿；注意许可证合规 |
| 依据 | 数据支持的判断：许可证与关键词显示存在商用与付费场景 |
面向细分需求的二次开发产品
| 产品构想 | 基于 commitlint 的核心能力，聚焦一个更窄的场景（如某平台、某行业）做差异化。 |
| 目标用户 | 该细分场景用户 |
| 难度/周期 | 中 · 2~6 周 |
| 收费模式 | 买断制 / 订阅制 / 广告 |
| 竞争风险 | 细分需求规模需验证 |
| 依据 | AI 推测：基于项目主题标签的判断 |
封装为在线小工具或 API 服务
| 产品构想 | 把项目最常用的一个功能做成网页小工具，靠流量变现或按量计费。 |
| 目标用户 | 搜索引擎带来的长尾用户 |
| 难度/周期 | 低 · 1~3 周 |
| 收费模式 | 免费引流 + 增值功能 / API 按量计费 |
| 竞争风险 | 同质化竞争，需做好 SEO |
| 依据 | AI 推测：基于技术栈与部署特征的判断 |
以上为规则引擎基于仓库公开数据生成的参考结论，包含推测成分，不构成投资或创业承诺；配置 AI 后可获得更深入的分析。
报告会保存到 个人中心
竞品与相似项目 GitHub Search 真实检索
| 项目 | 中文简介 | Stars | 语言 |
|---|---|---|---|
| typicode/husky | 中文介绍暂未生成 Git hooks made easy 🐶 woof! |
35,389 | JavaScript |
| tj/git-extras | 中文介绍暂未生成 GIT utilities -- repo summary, repl, changelog population, a |
18,130 | Shell |
| carloscuesta/gitmoji | 中文介绍暂未生成 An emoji guide for your commit messages. 😜 |
16,813 | TypeScript |
| pre-commit/pre-commit | 中文介绍暂未生成 A framework for managing and maintaining multi-language pre- |
15,692 | Python |
| pomber/git-history | 中文介绍暂未生成 Quickly browse the history of a file from any git repository |
13,685 | JavaScript |
| awslabs/git-secrets | 中文介绍暂未生成 Prevents you from committing secrets and credentials into gi |
13,441 | Shell |
以上为通过 GitHub 官方 Search API 检索的相似项目，功能差异与优劣势需进一步人工确认，配置 AI 后可生成对比分析。
项目优势与风险
| 技术成熟度 | 创建于 2016-02-12，近 30 天仍在推送，发布过 100 个 Release |
| 社区活跃 | Star 18,811 / Fork 980 / Issue 87（数据支持，可自行核实） |
| 许可证 | MIT |
| 主要风险 | 上游项目方向可能变化；同赛道竞争者较多（见竞品表）；热度与需求不完全等价 |
安装与使用
快速开始（以仓库 README 为准）
git clone https://github.com/conventional-changelog/commitlint.git cd commitlint # 请阅读仓库 README 获取确切安装步骤（依赖、配置、启动命令）
术语说明：Docker＝应用容器（把程序和依赖打包运行）；API Key＝调用外部服务的密钥；Git Clone＝把仓库代码下载到本地。常见错误：API Key 未配置 / 端口占用 / 数据库连接失败，多数项目在 README 的 Troubleshooting 章节有说明。