在前端开发中，我们通常需要使用 git 和 GitHub 进行版本管理和协同开发。而在提交代码时，我们也必须遵守一定的提交规范，以便更好地维护项目和协作合作。这时，我们就需要用到 npm 包 commitlint-config-squash-pr。
什么是 commitlint-config-squash-pr
commitlint-config-squash-pr 是一个针对 Git commit 信息进行校验的工具，它可以帮助团队保持提交信息的统一性和规范性。这个工具可以帮助我们：
- 校验 commit message 的长度
- 校验 commit message 的格式
- 校验 commit message 是否符合规范
如何使用 commitlint-config-squash-pr
- 首先需要安装 commitlint-config-squash-pr
npm install --save-dev commitlint-config-squash-pr
- 在项目根目录下创建 commitlint.config.js 文件
module.exports = {
extends: ['squash-pr'],
rules: {
// 这里可以自定义规则
'body-max-line-length': [2, 'always', 120],
},
};- 在 package.json 文件中配置 npm run commit
{
// ...
"scripts": {
"commit": "git-cz"
}
}- 使用 npm run commit 来提交代码
npm run commit
- 根据命令行提示填写 commit message
-- -------------------- ---- ------- - ------ --- ---- -- ------ ---- ------ ----------- ---- ----- ----- - ----- - --- ------- ---- - --- --- ----- ------------- ---- ------- ------ ------- ---- -- --- ------ --- ------- -- --- ---- ------------- ----------- ------- ------------ ---- --------- - ---- ------ ---- ------- ----- - --- --- ---- - ------- ----- - ---- ------ ---- -------- ----------- ----- ------ ------- ----- -- ---------- -------- ----- ------ ------- -- --- ----- ------- -- --------- ----- --- --------- ---- -- ------------- ---------- --- ------- -- ---- -- ------------- ----- --- -------
? What is the scope of this change (e.g. component or file name): (press enter to skip)
? Write a short, imperative tense description of the change (max 72 chars):
? Provide a longer description of the change: (press enter to skip)
? Are there any breaking changes? (y/N)
? Does this change affect any open issues? (y/N)
git commit -m "feat: 添加了 xxx 功能"
总结
commitlint-config-squash-pr 可以帮助我们更好地规范我们的团队协作开发过程中的代码提交信息，进一步提高开发效率和协作效率。希望这篇文章能对你有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/199343