在前端开发中，版本控制是非常重要的一项工作。为了方便管理版本信息，npm 包提供了一种非常实用的工具——conventional-changelog-videojs，可以帮助我们自动生成有关项目版本信息的 changelog。
本文将会为大家详细介绍 conventional-changelog-videojs 的使用方法以及其在前端开发中的指导意义。
1. 安装和使用
在使用 conventional-changelog-videojs 之前，我们需要先安装它。可以通过以下命令来安装：
npm install conventional-changelog-videojs --save-dev
安装完成后，我们需要将 conventional-changelog-videojs 加入到项目中的 package.json 中：
"scripts": { "changelog": "conventional-changelog -p videojs -i CHANGELOG.md -s" }
这里我们定义了一个名为 changelog 的 script，在执行该 script 时，它将会调用 conventional-changelog-videojs 并将 changelog 自动写入到项目根目录下的 CHANGELOG.md 中。
执行命令：
npm run changelog即可生成 changelog。
2. 配置项
默认情况下，conventional-changelog-videojs 会根据 Angular 团队的 Commit Message Conventions 规范去生成 changelog。我们可以在 package.json 中进行一些相关配置来定制化 changelog 的生成。
以下是一些常用的配置项：
2.1. types
types 是一个数组，用于指定在生成 changelog 时需要展现的 commit 类型。例如，以下配置项指定只展现 fix 和 feat 两种类型的 commit：
"config": { "changelog": { "types": [ "feat", "fix" ] } }
2.2. scopes
scopes 是一个数组，用于指定：当代码贡献者在向代码库提交代码时，选择的符合规范的 scopes。例如，以下配置项指定只展现 build 和 test 两个模块的 changelog：
"config": { "changelog": { "scopes": [ "build", "test" ] } }
2.3. commit
commit 是一个对象，包含提交对象的所有规则，例如：
-- -------------------- ---- ------- --------- - ------------ - --------- - ------------------- ---- ------------------- -- ------------------- ---- -------- - ------- ------ ---------- -- --------- - --------- --------- ---------- ------------ ----------- -- ---------------- - ----- ---------- ---------- ----------- ------------- ------------ - - - -展开代码
2.4. preset
preset 是一个字符串，用于指定 preset 规范，例如：
"config": { "changelog": { "preset": "angular" } }
3. 指导意义
conventional-changelog-videojs 的使用方法并不复杂，但它带来的指导意义却很大。它能够帮助我们形成一种 “conventional-commits” 的提交规范，在开发中能够更好地维护代码、跟踪版本、合并代码以及进行发布等工作。
在形成的规范中，每一次提交都要求有明确的类型、描述、变更内容、以及其他相关信息。这样的规范有利于整个项目的可读性、可维护性，同时也能够节省大量的时间和人力。
4. 示例代码
以下是一个 package.json 中 conventional-changelog-videojs 的相关配置的样例代码：
-- -------------------- ---- ------- - ------- ------------- ---------- -------- -------------- ----- -- -- --------- --------------- --- ------------------ - ----------------------------- -------- -- ---------- - ------------ ----------------------- -- ------- -- ------------ -- -- -- -- --------- - ------------ - --------- - ------------------- ---- ------------------- -- ------------------- ---- -------- - ------- ------ ---------- -- --------- - --------- --------- ---------- ------------ ----------- -- ---------------- - ----- ---------- ---------- ----------- ------------- ------------ - - - - -展开代码
希望这篇文章能够对大家在前端开发中使用 conventional-changelog-videojs 有所指导和帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/163768
