git 上傳項目代碼規範commitlint 配置安裝

安裝套件

yarn add @commitlint/config-angular @commitlint/cli husky
複製代碼

安裝完成後在 package.json 中增長以下的配置

"husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
}
複製代碼

上傳 git commit 規範配置這個文件表明之後commit -m 後面的提交應遵循的規範

// commitlint.config.js
module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'body-leading-blank': [1, 'always'],
    'footer-leading-blank': [1, 'always'],
    'header-max-length': [2, 'always', 72],
    'scope-case': [2, 'always', 'lower-case'],
    'subject-case': [2, 'never', ['sentence-case', 'start-case', 'pascal-case', 'upper-case']],
    'subject-empty': [2, 'never'],
    'subject-full-stop': [2, 'never', '.'],
    'type-case': [2, 'always', 'lower-case'],
    'type-empty': [2, 'never'],
    'type-enum': [2, 'always', ['upd', 'chore', 'docs', 'feat', 'fix', 'test', 'refactor', 'revert', 'style']]
  }
};
複製代碼

type-enum 就是咱們之後提交代碼要的提交內容例如

upd: 更新了組件內容
複製代碼

• docs：文檔更新
• upd：新增功能
• fix：bug 修復
• refactor：重構代碼(既沒有新增功能，也沒有修復 bug)
• style：不影響程序邏輯的代碼修改(修改空白字符，補全缺失的分號等)
• test：新增測試用例或是更新現有測試
• revert：回滾某個更早以前的提交
• chore：不屬於以上類型的其餘類型