commitlint 是一檢測 commit message 的工具。

使用上需先全域安裝 commitlint cli。

npm install -g @commitlint/cli

1.png

加入 package.json。

npm init

2.png

加入套件 @commitlint/config-conventional。

npm install -save @commitlint/config-conventional

3.png

加入 commitlint 設定檔。

echo “module.exports = {extends: [’@commitlint/config-conventional’]}” > commitlint.config.js

4.png

準備好後可簡易的用 echo 將訊息透過 pipeline 送到 commitlint 做些測試。

echo ‘foo: bar’ | commitlint

5.png

echo ‘feat: bar’ | commitlint

6.png

若要針對 git commit message 也是可以,這邊直接將當前專案加入 git 版控。

git init

7.png

設定 .gitignore。

vim .gitignore

8.png

將 node_modules 這些不必要版控的部分設定上去。

9.png

實際 commit 一個不符合規範的 commit message。

git add .

10.png

git commit -m “foo: bar”

11.png

git log

12.png

調用 commitlint 並帶入 –from=,commitlint 會去驗證 git commit message。

commitlint –from=

13.png

Link