在前端开发中，代码提交是非常重要的一环。一个好的提交信息可以提高合作效率、方便代码回溯以及更好地维护代码历史记录。而使用 conventional-changelog-eslint 可以生成符合规范的提交信息，使得项目管理更加有效。
什么是 conventional-changelog-eslint？
conventional-changelog-eslint 是一个 npm 包，它将 eslint 的消息格式与 conventional commits 规范相结合，可以自动生成符合规范的提交信息。这样的提交信息可以被大部分 CI/CD 工具直接解析，从而帮助我们更好地进行持续集成和持续交付。
如何使用 conventional-changelog-eslint？
首先，需要安装 conventional-changelog-eslint：
--- ------- -- -----------------------------
接着，在 package.json 中配置 script：
-
---------- -
------------ ------------------------------ -- ------ ------------- ------------
-
-这里的 -p eslint 表示用 eslint 的配置来生成提交信息，$GIT_PARAMS 是 git 提交信息所在的文件路径。
最后，在 .eslintrc 中配置 eslint-plugin-conventional-commit 插件，以检测提交信息是否符合规范：
-
---------- ------------------------
-------- -
------------------------------------------- -
--------
-----------------------
--
----------------------------------------- -
--------
---------
---------------
-
-
-这里的 commit-message-regex 规则表示提交信息必须以类似 [feat] add new feature 的形式开头，而 commit-header-case 则表示提交信息的第一个单词首字母需要大写。
现在，每当执行 git commit 命令时，会自动调用 conventional-changelog-eslint 生成规范化的提交信息，并通过 eslint-plugin-conventional-commit 插件检测信息是否符合规范。如果不符合规范，提交将被拒绝。
示例
假设我们要提交一条新功能的信息，可以按如下步骤操作：
- 在代码中完成新功能的实现。
- 执行
git add命令将新代码添加到暂存区。 - 执行
git commit -m "[feat] add new feature"命令提交代码，并附带一条符合规范的提交信息。
在这个例子中，conventional-changelog-eslint 会自动生成类似于 feat: add new feature 的提交信息，并且在 eslint-plugin-conventional-commit 插件的检测下通过。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/49549