conventional-changelog-chestnut

介绍

一款conventional-changelog日志模板

参考于conventional-changelog-angular

安装准备

先确保安装依赖包

• commitizen
• cz-conventional-changelog
• conventional-changelog-cli

安装

npm install conventional-changelog-chestnut --save-dev

使用

{
	"scripts": {
		"changelog": "conventional-changelog -p chestnut -i CHANGELOG.md -s -r 0"
	}
}

配置

需要在项目根目录下创建.chestnutlogrc文件，这里提供了一份参考文件

types

type: Array

默认的参数类型是根据commitizen提供，根据git commit message的type输出日志

数组元素设置必须包含type和alias字段

数组必须至少有一项，否则会使用默认配置

{
  "types": [
    {
      "type": "feat",
      "alias": "Features"
    }
  ]
}

authorName

type: Boolean, default: false

是否显示提交人

{
	"authorName": false
}

authorEmail

type: Boolean, default: false

是否显示提交人邮箱

{
	"authorEmail": false
}

License

MIT © bnuephjx