特性

• 轻松创建常规提交
• 与 cocogitto 结合使用，实现自动版本控制、生成变更日志等功能
• 使用表情符号 👋（或，短代码）
• 提交作用域自动补全
• 作为 git 钩运行
• 自定义提交类型

安装

webi

curl -sS https://webinstall.dev/koji | bash

cargo

cargo install --locked koji

请确保已安装 git。

使用方法

使用 koji 的基本方法是将它作为 git commit 的替代品，通过交互式提示符强制执行 常规提交 标准。

# Do some work
cd dev/koji
git add README.md

# Commit your work
koji

使用 koji --help 查看更多选项。

作为 git 钩使用

另一种使用 koji 的方法是将其作为 git 钩 使用，在运行 git commit 时运行它。

手动

更新 .git/hooks/prepare-commit-msg 以下代码

#!/bin/bash
exec < /dev/tty && koji --hook || true

husky

npx husky add .husky/prepare-commit-msg "exec < /dev/tty && koji --hook || true

rusty-hook

将此添加到您的 .rusty-hook.toml

prepare-commit-msg = "exec < /dev/tty && koji --hook || true"

对于任何钩子运行器，类似的设置应该都适用，只需确保您使用的是 prepare-commit-msg 钩子。

当将其作为钩子使用时，传递给 git commit -m 的任何消息都将用作提交摘要。将您的提交编写为常规提交，例如 git commit -m "feat(space): delete some stars"，将完全绕过 koji。

autocomplete = true

breaking_changes = true

[[commit_types]]
name = "feat"
emoji = "✨"
description = "A new feature"

emoji = true

issues = true