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上

有關如何貢獻的更多信息，請查看我們的貢獻指南。