conventional-changelog-lint-config-canonical 是一个适用于 conventional-changelog-lint 的预设配置。本文将深入介绍其使用方法。
什么是 conventional-changelog-lint？
conventional-changelog-lint 是一个基于 conventional-commits 规范的提交消息检查工具。它可以帮助开发者在项目中规范提交信息，以方便生成更好的 changelog。
conventional-changelog-lint-config-canonical 的作用
conventional-changelog-lint-config-canonical 是一个常用的 conventional-changelog-lint 预设配置。它包含了一系列校验规则，可用于检查提交信息是否符合 conventional-commits 规范。
具体来说，它包含了以下四条校验规则：
- type-enum：指定了 commit message 类型（feat、fix、docs 等），确保提交消息类型正确且必填。
- subject-case：检查提交消息的首字母是否大写，以及是否包含句号等标点符号。
- scope-case：检查提交消息的作用域格式，要求全部小写，以短横线分割。
- body-max-line-length：检查提交消息的主体部分是否超过 72 个字符，以保证 changelog 的可读性。
使用 conventional-changelog-lint-config-canonical 可以提高项目代码质量，并且方便项目协作和维护。
如何使用 conventional-changelog-lint-config-canonical？
首先需要安装 conventional-changelog-lint 和 conventional-changelog-lint-config-canonical：
npm install --save-dev conventional-changelog-lint conventional-changelog-lint-config-canonical
然后在项目根目录下创建 .commitlintrc.js 文件，并添加以下内容：
-- -------------------- ---- ------- -------------- - - -------- ------------------------------------ ------ - ------------ - -- --------- - ------- ------ ------- -------- ----------- ------- -------- ----- -------- -------- - -- --------------- --- --------- ----------------- ------------- --- --------- -------------- ----------------------- --- --------- --- - --展开代码
这里我们使用了 conventional-changelog-lint 自带的 @commitlint/config-conventional 预设配置，并扩展了我们特定的校验规则。你也可以直接在 .commitlintrc.js 中定义所有的校验规则。
最后，在 package.json 中添加以下内容：
{ "scripts": { "commitmsg": "conventional-changelog-lint -e $GIT_EDITOR" } }
这将在提交代码时自动检查提交信息是否符合规范。
示例
下面是一些符合 conventional-commits 规范的提交消息：
-- -------------------- ---- ------- ----------- --- --- ------- --------- --- - --- -- --- ------------- ------ ------ ----------- ------ --- ---- --------------------- -------- ---------- ---------- --- --- ----- -------------- ----- ------ ----- ----------- ------ ------ -- ------------- -------------------- ------ ------------ ------- ------ ---- ------展开代码
而以下则是不符合规范的提交消息：
Add new feature #123 Fix a bug in API Docs: update readme.md. refactor components add unit test for login api. bump version to v1.0.1
总结
使用 conventional-changelog-lint-config-canonical 可以帮助我们统一项目中的提交信息，提高协作
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/46788
