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 是需要发布到生产环境的。