关于前端:changelog-日志自动生成工具升级啦

背景

19 年我发了一篇文章 changelog 日志主动生成插件, 外面介绍了我开源的一套【auto changelog、commit-lint】规范化代码提交的工具插件合集。

然而因为是第一次公布一些开源的我的项目，不免开发计划不是很丝滑，用起来也不是很柔顺。

所以基于这些问题，用 lerna 对这个工具进行了一次降级。大略内容如下：

jimi-web-changelog/cz --> nicecode/commit   // git 格式化 cli 提交插件
jimi-web-changelog/lint  -->  nicecode/commit-lint    // git 提交 lint 校验插件
jimi-web-changelog --> nicecode/changelog   // 日志主动生成插件 

CZ 模块配置优化

官网文档

原配置

// 1、装置依赖
cnpm i commitizen jimi-web-changelog --save-dev

// 2、在 package.json 中增加
{
  ...
  "config": {
    "commitizen": {"path": "./node_modules/jimi-web-changelog/lib/cz"}
  },
  ...
}

新配置

// 1、装置依赖
cnpm i commitizen @nicecode/commit --save-dev

// 2、在 package.json 中增加
{
  ...
  "config": {
    "commitizen": {"path": "@nicecode/commit"}
  },
  ...
}

lint 模块配置优化

官网文档

原配置

1. 装置依赖
cnpm i husky commitlint jimi-web-changelog --save-dev

2. 在 package.json 中引入以下配置
{
  ...
  "husky": {
    "hooks": {"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"}
  },
  ...
}

3、根目录下 .commitlint.js 
modules.exports = Object.assign({}, require('jimi-web-changelog/lib/lint'), {
  rules: {'subject-empty': [2, 'never'],
    'type-empty': [2, 'never'],
    'type-enum': [2, 'always',
      [
        '新性能',
        '修复',
        ...
      ]
    ]
  }
}

新配置

// 1. 装置依赖
cnpm i husky commitlint @nicecode/commit-lint --save-dev

// 2. 在 package.json 中引入以下配置
{
  ...
  "husky": {
    "hooks": {"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"}
  },
  ...
}

// 3、根目录下 .commitlint.js 
modules.exports = {extends: ["@nicecode/commit-lint"]
}

changelog 模块配置优化

官网文档

原配置

// 1、装置依赖
cnpm i conventional-changelog-cli jimi-web-changelog --save-dev

// 2、在 package.json 中增加命令
{
  ...
  "script": {"log": "conventional-changelog --config node_modules/jimi-web-changelog/lib/log -i CHANGELOG.md -s -r 0",}
  ...
}

新配置

// 1、装置依赖
cnpm i conventional-changelog-cli @nicecode/changelog --save-dev

// 2、在 package.json 中增加命令
{
  ...
  "script": {"log": "conventional-changelog --n node_modules/@nicecode/changelog -i CHANGELOG.md -s -r 0",}
  ...
}

后记

nicecoder 团队 目前 4 人，致力整合一套进步工作效率和代码标准的工具库，目前咱们的打算的和已实现的有以下几个板块：

期待你的退出：nicecoder

相干链接

@nicecode/tools 罕用函数库

nicecode 官网

nicecode github 地址