简介
conventional-changelog-jshint 是一个可以根据 git commit 提交信息自动生成 changelog 的 npm 包，同时还可以对提交信息进行 jshint 静态代码分析。此包可以帮助我们自动化生成 changelog，并提高代码质量。本篇文章将介绍如何使用此包。
安装
使用 npm 进行全局安装：
npm install -g conventional-changelog-jshint
生成 changelog
初始化
在使用之前，我们需要在项目根目录下进行初始化：
conventional-changelog init
配置
初始化完成后，我们可以编辑根目录下的 .conventional-changelog.json 文件进行自定义配置。以以下基本配置为例：
-- -------------------- ---- ------- - --------- ---------- --------------- -- ------------------- ----- -------- - - ------- ------- ---------- ---------- -- - ------- ------ ---------- ---- ------ -- - ------- -------- --------- ---- -- - ------- ------- --------- ---- -- - ------- -------- --------- ---- -- - ------- ----------- --------- ---- -- - ------- ------- --------- ---- -- - ------- ------- --------- ---- - - -展开代码
上面的配置代表我们使用的是 angular 的预设规则，只会包含 feat 和 fix 两个类型的 commit，未发布内容会被输出，其他类型的 commit 不会被记录在 changelog 中。
生成
使用以下命令即可生成 changelog：
conventional-changelog -p angular -i CHANGELOG.md -s
其中，
p表示使用预设规则，可以自定义。i表示输出的文件路径，默认是在工程根目录下生成一个 CHANGELOG.md。s表示直接将 changelog 内容输出到终端。
我们可以将生成 changelog 的命令添加到 npm run 命令中，这样就可以在打包上传之前很方便地生成并更新 changelog 了。
静态代码分析
除了生成 changelog，conventional-changelog-jshint 还可以通过对提交信息进行 jshint 静态代码分析，来保证提交信息规范并符合代码规范。
我们可以在项目根目录下添加 .jshintrc 文件来自定义 jshint 规则，或者使用默认的规则。
在提交代码时，我们可以通过以下命令进行分析：
conventional-changelog-jshint path/to/file.js
其中，path/to/file.js 为需要分析的文件路径。
我们同样可以将分析代码的命令添加到 npm run 命令中，在每次提交代码之前都进行一次静态代码分析，从而保证代码质量。
结语
conventional-changelog-jshint 包可以帮助我们自动化生成 changelog，并保证提交信息规范和代码质量，提高代码开发效率和质量。希望本文可以对大家有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/40349
