什么是 @marionebl/conventional-changelog-core？
@marionebl/conventional-changelog-core是一个npm包，可以生成符合conventional commits规范的changelog。conventional commits规范是一个约定俗成的提交信息规范，可以更好地描述代码变更的类型。使用这个规范提交信息可以帮助您更好地组织您的变更并自动生成change log文件。
如何使用 @marionebl/conventional-changelog-core？
安装
您可以通过以下命令安装 @marionebl/conventional-changelog-core：
npm install @marionebl/conventional-changelog-core --save
配置
在您的项目中，您需要创建一个conventional-changelog配置文件，用于定义您的changelog格式。这个文件可以是一个JavaScript文件，也可以是一个JSON文件。这里我们选择使用JavaScript文件，命名为changelog.js。
以下是一个简单的changelog.js文件示例：
-- -------------------- ---- -------
-------------- - -
------ -
- ----- ------- -------- ---------- --
- ----- ------ -------- ---- ------ --
- ----- -------- -------- -------- --
- ----- ------- -------- --------------- --
- ----- -------- -------- -------- --
- ----- ----------- -------- ---------- --
- ----- ------- -------- ------------- --
- ----- ------- -------- ------- --
- ----- -------- -------- ------ ------- --
- ----- ----- -------- ----------- ------------ --
--
--在这个配置文件中，我们定义了十个变更类型(types)，以及对应的section名称。section用于分类您的变更并将其在changelog文件中归组。
执行
一旦您的配置文件准备好了，就可以使用@marionebl/conventional-changelog-core生成changelog文件。以下是一个生成changelog文件的示例node脚本：
-- -------------------- ---- -------
----- ------------------------- - --------------------------------------------------
----- -- - --------------
----- ---- - ----------------
----- ---------- - ----------------------- ----------------
----- ------ - --------------------------
---------------------------------
------------ -- -
---------------------------- ------
---------------------- -------------
--
------------ -- -
-------------------
---在此脚本中，我们引入了@marionebl/conventional-changelog-core，并传递了我们在前面定义的changelog配置文件。我们还指定了生成的changelog文件，位置为CHANGELOG.md。最后，我们使用fs模块将生成的数据写入到指定的文件中。
示例代码
以下是一个完整的示例，演示了如何使用@marionebl/conventional-changelog-core生成changelog文件：
安装依赖
npm install @marionebl/conventional-changelog-core --save
创建配置文件
我们创建一个名为changelog.js的文件，包含以下内容：
-- -------------------- ---- -------
-------------- - -
------ -
- ----- ------- -------- ---------- --
- ----- ------ -------- ---- ------ --
- ----- -------- -------- -------- --
- ----- ------- -------- --------------- --
- ----- -------- -------- -------- --
- ----- ----------- -------- ---------- --
- ----- ------- -------- ------------- --
- ----- ------- -------- ------- --
- ----- -------- -------- ------ ------- --
- ----- ----- -------- ----------- ------------ --
--
--创建脚本文件
我们创建一个名为generate-changelog.js的文件，包含以下内容：
-- -------------------- ---- -------
----- ------------------------- - --------------------------------------------------
----- -- - --------------
----- ---- - ----------------
----- ---------- - ----------------------- ----------------
----- ------ - --------------------------
---------------------------------
------------ -- -
---------------------------- ------
---------------------- -------------
--
------------ -- -
-------------------
---运行脚本
如果一切顺利，我们运行以下命令将生成CHANGELOG.md文件：
node generate-changelog.js
结论
使用@marionebl/conventional-changelog-core可以很容易地添加change log到您的项目中。通过遵循conventional commits规范提交信息，您可以自动生成详细的changelog文件，更好地组织您的项目变化历史，帮助您的贡献者更好地理解您的项目。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066bca967216659e244626