commitlint

入门|网站

皮棉提交消息

SVG-Term-CLI产生的演示

cat docs/assets/commitlint.json | svg-term --out docs/public/assets/commitlint.svg --frame --profile=Seti --height=20 --width=80

• 做一个好commitizen

• 通过npm共享配置

• 点击conventional-changelog

内容

• 入门|网站

• 安装并运行

• 发行

• 使用commlint的好处

• 内容

• 什么是commlint

• 入门

• CLI

• config

• 共享配置

• 文档

• API

• 工具

• 路线图

• 版本支持和发布

• 相关项目

• 执照

• 发展

---

什么是commlint

commitlint检查您的提交消息是否符合常规提交格式。

通常，模式通常看起来像这样：

类型（范围？）：主题#scope是可选的；支持多个范围（当前定界符选项：“/”，“和”，“）

现实世界的例子看起来像这样：

chore: run tests on travis ci

fix(server): send cors headers

feat(blog): add comment section

根据commlint-config-contentional（基于角度惯例）的常见类型可以：

• 建造

• 琐事

• CI

• 文档

• 壮举

• 使固定

• perf

• 重构

• 恢复

• 风格

• 测试

这些可以通过您自己的配置来修改。

使用commlint的好处

• 为什么要使用常规提交？

• “惯例的特权”（谈话幻灯片）

入门

• 本地设置 - 与沙哑的提交有关的棉绒消息

• CI设置 - CI构建期间的棉绒消息

CLI

• 与commitlint互动的主要方法。

• npm install --save-dev @commitlint/cli

• 软件包：CLI

config

• 配置是从以下方式拾取的：

• .commitlintrc

• .commitlintrc.json

• .commitlintrc.yaml

• .commitlintrc.yml

• .commitlintrc.js

• .commitlintrc.cjs

• .commitlintrc.mjs

• .commitlintrc.ts

• .commitlintrc.cts

• commitlint.config.js

• commitlint.config.cjs

• commitlint.config.mjs

• commitlint.config.ts

• commitlint.config.cts

• package.json中的commitlint字段

• package.yaml中的commitlint字段

• 软件包：CLI，核心

• 有关可能的规则列表，请参见规则

• 可以在 @commitlint/config-contentional上找到一个示例配置

共享配置

许多共享配置可与commitlint一起安装和使用：

• @commitlint/config-angular

• @commitlint/config-contentional

• @commitlint/config-lerna-scopes

• @commitlint/config-nx-scopes

• @commitlint/config-patternplate

• 常规的变性薄荷元素原子

• 常规的变性 - 薄荷 - config-canonical

配x commitlint-config-your-config-name要发布自己emoji-log可共享commitlint-config-emoji-log或your-config-name 。

文档

检查主要网站。

API

• 与commitlint互动的替代方法的方法

• 软件包：

• 格式 - 格式提交报告

• 棉绒 - 棉绒针对commitlint规则

• 加载 - 加载共享的commlint配置

• 阅读 - 从指定范围或上次编辑中读取提交消息

• 有关方法和示例的完整列表，请参见API

工具

• 提交适配器

• 迅速的

路线图

commitlint被认为是稳定的，并在各种项目中用作开发工具。

想法：常规变性/提案＃94

版本支持和发布

• node.js lts >= 18

• git >= 2.13.2

发行

安全补丁将应用于尚未EOL的版本。
功能仅应用于当前的主版本。

发布	初始版本
V19	02/2024
V18	10/2023

EOL通常是大约一年后。

我们不是赞助的OSS项目。因此，我们不能保证我们将及时发布旧版本的补丁版本。
如果您陷入较旧版本，并且需要安全补丁，那么如果您可以提供PR，我们很高兴。

相关项目

• 传统变换物产生来自常规提交历史的更改

• 提交简单的互联网公民会议

• 创建语义模块CLI，以快速将订单和commitlint快速整合到新项目或现有项目中

执照

@marionebl版权。所有commitlint软件包均根据MIT许可发布。

发展

commitlint是在单声道存储库中开发的。

安装并运行

git clone [email protected]：常规 -  changelog/commitlint.gitcd commlint
纱
纱线运行构建＃运行构建taskearn start＃运行测试，再次在changeyarn run commlint＃run cli上

有关如何贡献的更多信息，请查看我们的贡献指南。