在前端开发中，我们经常需要记录代码的版本变更信息，来方便维护和开发。而 bw-changelog 就是一个便捷的 npm 包，可以帮助我们生成易读且美观的变更记录日志。
安装
使用 npm 安装 bw-changelog：
npm install bw-changelog
使用
初始化
我们需要在项目根目录下新建一个 changelog 目录，里面包含一个配置文件 changelog.config.js 和一个空的变更日志文件 changelog.md，执行如下命令：
npx bw-changelog init
添加新的版本变更记录
我们在代码仓库中进行了修改，我们想要将所做出的更改添加到记录日志文件，我们可以执行以下命令：
npx bw-changelog add
这个命令会询问您某些问题，以帮助您生成适当的更新记录。您可以更新的东西包括类型、范围、主题和详细描述。
如：
-- -------------------- ---- ------- - ------ --- ---- -- ------ ---- ------ ----------- ----- - ---- -- --- ----- -- ---- ------ ----- --------- -- ---- ------ ------ - ----- - ------ ---------- ----- ----------- -- --- ------- --- -------- -- ----------------- -- --- -- --- --- --------- - ------- - ------ ----------- -- --- ------- --- - --- ------- -- --- ----------------- --------------- ----- --- -------- -- ------ ---------- ------- -------- --- ----- ------------ --- --- ------- - --- ----- --- -------- -------- -- - ---- ---- ------ ------ --- ---- ------- ---
这些问题至少需要回答第一个问题，以便将其归档到适当的章节中；其他问题的答案都是可选的。当完成时，记录会保存到 changelog.md 文件中。
发布新版本
在所有变更都已记录并且您准备发布新版本时，可以如下操作：
在 package.json 文件中更新版本号。
运行以下命令，自动生成一个固定格式的 commit 并推送到代码仓库：
npm run release
自动化工具将运行并通过推送新标记来发布新版本。
生成 changelog 版本记录
要生成版本记录，您只需要运行：
npm run changelog
它将解析您的 changelog/ 目录，准备好一个新的记录，将版本记录附加到底部，并将其保存为 changelog.md 文件。
查看历史变更记录
要查看浏览器中的记录，只需打开 changelog.md 文件即可。可以在此文件中找到之前版本的更改记录。
示例代码
以下是一个示例 changelog.config.js 文件：
-- -------------------- ---- -------
-------------- - -
------ -
- ------ ------- ----- ------ ---- --
- ------ ------ ----- ----- --- --- --
- ------ ------- ----- ------ ----- --
- ------ -------- ----- ------- ------- --
-
------ -----------
----- ---------- ------
--
-
------ -------
----- ------ ---------
--
- ------ ------- ----- ------ --- --
-
------ --------
----- ------- ------------
--
-
------ -----
----- ---- -------
--
--
------- -
- ----- ------ --
- ----- ----- --
- ----- ------------ --
- ----- ------ --
- ----- ------- --
- ----- ------- --
- ----- ------- --
- ----- ------ --
--
------------------ -----
-- ------
--------- -
----- ------------
------
--------------
--------
-------------
-----
---------------- -- --- -------
---------
------------------------
-------------- ----------
--
-- ------------------------
-------- -
------------------------------------
--------------------------------------------
------------------------------- - --------------- ------ ---
------------------------- - ----------- ----- ---
------------------------- - ------- ---------------- --------------- ---
---------------------------
--
-- ---- ------------- - ----------- ---------
-- ------- ---------------- - --------------
-- ---------- -----
-- ----------- -----
--结论
bw-changelog 不仅仅是一个工具，它更是一种思想与规范，而且使用 bw-changelog，也是遵守了一定的规范，让代码管理变得更加简单、易于理解和维护。
参考文献：
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005572481e8991b448d4183