git commit message規范與約束(項目內安裝)

Commitizen、Commitlint、Husky、Standard-version項目內安裝和使用

一、在項目的根目錄下創建package.json文件

  npm init --yes

二、安裝配置Commitizen

• 命令安裝

  npm install -D commitizen 
  npm install -D cz-conventional-changelog

• 在package.json中配置

  "script": {
    ...,
    "commit": "git-cz",
  },
  "config": {
    "commitizen": {
      "path": "node_modules/cz-conventional-changelog"
    }
  }

配置完成之后就可以使用了，與全局安裝時的命令git cz不同，項目內安裝之后的使用命令為：

  npm run commit

三、Commitlint安裝和配置

• 命令安裝

  npm i -D @commitlint/config-conventional 
  npm i -D @commitlint/cli

• 配置：在項目的根目錄下創建配置文件commitlint.config.js，並寫入:

 module.exports = {
  extends: [
    ''@commitlint/config-conventional''
  ],
  rules: {
  }
};

四、安裝配置Husky

• 命令安裝

  npm i -D husky

• 在package.json中配置：

  "husky": {
    "hooks": {
      ...,
      "commit-msg": "commitlint -e $GIT_PARAMS"
    }
  }

這個配置會在.git/hooks在創建commit-msg文件

五、Standadr-version的安裝和配置

• 命令安裝

  npm install -D standard-version

• 在package.json中配置

  "script": {
    ...,
    "release": "standard-version",
  }

• 使用

  npm run release
  npm run release -- -f

六、總結

• 最終使用方法：項目中會配置好package.json和commitlint.config.js文件。使用時只需要進入項目執行npm install即可。

• npm install 使用說明：

  1. npm install就是npm insatll -s就是npm install --save，使用此命令安裝的依賴包，會被寫入dependencies 區塊里。
  2. npm install -D就是npm insatll -d就是npm install --save-dev，使用此命令安裝的依賴包，會被寫入devDependencies 區塊里。
  3. 在package.json 文件里，devDependencies 里面的插件只用於開發環境，不用於生產環境，而 dependencies 是需要發布到生產環境的。