随着项目越来越复杂，变更日志是一个必不可少的工具。而 changelog-md 就是一个非常好用的 npm 包，可以帮助我们很方便地生成符合标准的变更日志。
安装
可以通过 npm 命令安装：
--- ------- -- ------------
使用
使用 changelog-md 很简单。先进入你的项目目录，然后执行下面的命令：
------------ -- -------- -- -------- -- -----
这个命令会自动扫描 git 的提交记录，并生成变更日志。其中：
username是你的 GitHub 用户名reponame是你的项目名称token是你的 GitHub AccessToken
如果你不想每次都输入，也可以先设置环境变量：
------ ----------------------------------------
这样，以后执行 changelog-md 的时候就不需要再指定 token 了。
生成格式
changelog-md 会生成一个符合 Keep a Changelog 标准的变更日志。例如：
-- ------------ --- ----- - -------- --- ------- - -------- --- ------- - ------------ -- ------- - ---------- --- ----- - ------------ --- ------- - ------- --- ----- - --------
自定义配置
可以在项目的根目录添加一个 .changelog-md.json 文件，来自定义 changelog-md 的配置。例如：
-
----------- -
---------- ----------------------------------------------
------- --------------
-------------- --- ------ --------- ----------
----------- -
------------- -
---------- ---------------
----------------- -----
--
---------- -
---------- ----------- - ----------
----------- -----------------------
--
------- -
----------- -- --------- ------- -------- ---------
--
-------- -
------- -
-------------- -----
--
------ -
-------------- ---- ---
--
------- -
-------------- ------
--
-------- -
-------------- ------
--
----------- -
-------------- ----
--
------- -
-------------- ------
--
------- -
-------------- --------
--
-------- -
-------------- --------
--
----- -
-------------- --------
--
-------- -
-------------- ------
-
-
-
-
-这个配置文件中，可以指定 changelog-md 的输出格式、版本号格式、类型、描述等。更详细的配置方式可以参考官方文档。
结论
通过 changelog-md，我们可以很方便地生成符合标准的变更日志。当项目越来越大时，这是一个非常高效和实用的工具。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/600562a181e8991b448dfd0b