#commit-message #git-commit #conventional-commits #friendly #style #tool #prompt

bin+lib glint

一个用于在 commitlint 风格下创建提交的友好工具

14 个版本 (1 个稳定版)

6.3.4 2021 年 9 月 1 日
0.6.2 2020 年 10 月 12 日
0.5.0 2020 年 8 月 15 日
0.4.0 2019 年 9 月 29 日
0.1.7 2019 年 9 月 15 日

#1831 in 命令行工具

MIT 许可证

335KB
2K SLoC

glint 是一个在 conventional 风格下创建提交的友好工具。

screen recording of usage

安装

您可以从 发布页面 下载 MacOSX、Linux 和 Windows 的二进制文件。存档中包含名为 'glint' 或 'glint.exe' 的文件,您应该将其放置在您的 PATH 范围内。

注意:Windows 二进制文件仅在 Windows 10 的 cmd.exe 上进行了测试。

或者 安装 rust 工具链,重启您的 shell,然后运行以下命令

cargo install glint --locked

假设 ~/.cargo/bin 在您的 PATH 中(安装程序默认会这样做),您应该能够运行 glint 并获取用法信息。

更新

要从 发布页面 下载较新版本,使用 which glint 查看之前保存的位置。只需用新版本替换二进制文件即可。

如果您使用 cargo 安装,则更新会更简单

cargo install glint --force

用法

主要命令是 glint commit,您可以将其缩短为 glint c

如果没有其他参数运行,您将按顺序接收每个提示。

要将额外的参数传递给最终的 git commit 命令,请使用 -- 标记 glint 参数的结束。

# Set the commitlint type to 'docs', and also ask git to sign the commit
glint commit -t docs -- -S

提示:文件

第一个提示允许您选择要添加到提交的文件。如果之前没有使用 git add 将文件暂存(例如在运行 glint 之前),则不会显示此提示。

这是一个简单的复选框列表,您可以使用上/下箭头键导航,并使用空格键切换。

您还可以通过切换名为 "" 的列表项来切换所有文件(即使其中一些是隐藏的)。

按 'd' 键将显示高亮行的文件(夹)的 diff,您可以通过按 'q' 键退出。

准备好后,按 Enter 键转到下一个提示。

提示:类型

每个提交都需要一个类型,您可以通过交互式输入或运行 glint 时使用 -t/--type 标志来提供。

您可以

  • 按字母键过滤列表,当只剩下一个选项时,它会自动提交
  • 使用箭头键在列表中上下导航,按 Enter 键选择一个

如果您需要使用列表中不存在的类型,请在运行 glint 时使用 glint c -t other-type 标志。

提示:作用域

选择类型后,您可以提供可选的作用域。您可以简单地键入您想要的作用域,完成后按 Enter 键。

不提供作用域也是有效的,在这种情况下,提交信息将不包含括号(例如,“修复:某些错误”可能是最终的提交信息)。

完成后按 Enter 键,或按 Escape 键返回到类型提示。

提示:信息

最后一步是编写您的提交信息。提供了一个基本的内联文本编辑器,您可以像往常一样输入。

有一些额外功能(未来可能会增加)

  • Ctrl-A, Ctrl-E 移动到行的开始/结束
  • 箭头键导航,包括导航到没有文本的位置(例如,按向下键将插入新行)

当您对提交信息满意时,按 Enter 键提交并完成提交。您可以按 Escape 键返回到作用域提示。

依赖项

~5MB
~87K SLoC