在前端开发中,我们经常需要提交代码到 Git 仓库。但是,对于一些比较繁琐的提交流程,如填写 commit message,可能会影响开发效率。为了解决这个问题,有一个很方便的 npm 包叫做 gitcommit
。
安装
首先,我们需要全局安装 gitcommit
。在命令行中输入以下命令:
npm install -g gitcommit
使用
命令行
在命令行中,我们可以通过以下命令使用 gitcommit
:
gitcommit
运行该命令后,会弹出一个交互式界面,让你填写 commit message,包括类型、描述和关联的 issue 编号等信息。
填完信息后,按 Ctrl + S
保存即可完成提交。
配置
除了命令行使用外,gitcommit
还可以通过配置文件来定制提交流程。在项目根目录下创建 .gitcommitrc.json
文件,并添加以下内容:
-- -------------------- ---- ------- - -------- - - -------- ------- ------- ----- ------- -- - -------- ------ ------- ---- ---- ---- -- - -------- ------- ------- ---- -------- -- - -------- -------- ------- ---- --- -------- -- - -------- ----------- ------- ---- ----------------- -- - -------- ------- ------- ---- ----- -- - -------- ------- ------- ---- ------- -- - -------- -------- ------- ------ --------------------- ---------- -- - -------- ----- ------- ------ - -------------- -- - -------- -------- ------- ---- ----------------- - -- ----------------- - ------ - - ------- ------- -- - ------- ------- -- - ------- --------- -- - ------- ---------- - - -- -------------------- ----- ----------------------- - ------- ----- -- ----------------- --- --------------- -- -
其中,types
属性定义了可选的 commit 类型,scopeOverrides
属性定义了不同类型的可选范围,allowCustomScopes
属性允许自定义范围,allowBreakingChanges
属性定义了可以引入 breaking changes 的类型,bodyLineLength
属性定义了 body 部分的最大长度,subjectLimit
属性定义了 subject 部分的最大长度。
修改完配置文件后,在命令行中运行 gitcommit
命令即可根据配置提交代码。
示例代码
const sum = (a, b) => { return a + b; }; console.log(sum(1, 2));
使用 gitcommit
提交该代码时,填写 commit message 如下:
feat: 新增 sum 函数 添加 sum 函数以实现两个数相加的功能 关联 issue #123
这样就完成了一次简单的 commit 提交,而无需手动打开编辑器
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/52463