changelog 日誌自動生成插件

功能

該工具針對一些須要手動輸入更新日誌的項目，實現自動化輸出更新日誌，而且對更新日誌進行內容格式化，便於後期維護，目前主要有如下幾個功能模塊。

1. cz -- 定製化 git 提交
2. log -- 自動生成 CHANGELOG.MD 日誌文件
3. lint -- 校驗 commit 信息

安裝依賴包

npm install jimi-web-changelog --save
// or
yarn add jimi-web-changelog --save-dev
複製代碼

1、cz 模塊

1. 安裝 commitizen 依賴包

cnpm i commitizen --save-dev

2. 在 package.json 中加入如下內容

{
  ...
  "config": {
    "commitizen": {
      "path": "./node_modules/jimi-web-changelog/lib/cz"
    }
  },
}
複製代碼

3. 在 package.json 中建立如下 script 命令

{
  "cz": "git add . && git cz"
}
複製代碼

按照提示正確輸出 commit 信息內容，以下示例：

2、log 模塊

1. 安裝 conventional-changelog-cli 依賴包

cnpm i conventional-changelog-cli --save-dev
複製代碼

2. 建立如下命令

{
  ...
  "script": {
    "log": "conventional-changelog --config node_modules/jimi-web-changelog/lib/log -i CHANGELOG.md -s -r 0",
  }
}
> 結尾數字若爲 1 ，生成當前版本的變化狀況，若爲 0， 生成全部的日誌文件。
複製代碼

3. 示例

3、lint 模塊

1. 安裝 husky commitlint 依賴

cnpm i husky commitlint --save-dev
複製代碼

2. 在 package.json 中引入如下配置。

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

3. 在項目根路徑下建立 .commitlint.js 或者 commitlint.config.js

具體配置能夠參考 commitlint 官方，例子：

module.exports = Object.assign({}, require('jimi-web-changelog/lib/lint'), {
  rules: {
    'subject-empty': [2, 'never'],
    'type-empty': [2, 'never'],
    'type-enum': [2, 'always',
      [
        '新功能',
        '修復',
        ...
      ]
    ]
  }
}
複製代碼

建議

能夠搭配 husky 和 lint-stage 效果更佳。它能在你每次提交代碼前校驗你的代碼格式並修復錯誤的代碼格式，具體配置能夠參考當前根目錄下的 package.json 和 .eslintrc.

Q&A

1. No files added to staging! Did you forget to run git add？

應該沒有文件內容變更還執行 git add . 提交致使的。試着對項目進行更改再保存試試。

2. 提交後，輸入更新日誌命令，CHANGELOG.MD 內容沒有更新？

只有每次版本迭代的的時候纔會更新這一次的日誌信息。能夠嘗試打個標籤最爲封版。

3. mac 沒法運行 git 命令，報錯？

能夠試試安裝 xcode.

xcode-select --install

4. 打印日誌沒有版本號？

版本號目前支持的格式爲 vX.X.X，👀格式對嗎？

5. js如何讀取 md 文件？

若是該項目使用了 webpack，可使用 markdown-loader.

第一次寫工具庫，不免有瑕疵，歡迎你們 pr，可是還請口下留情😄
喜歡的話給個 star吧
複製代碼