Lib.rs

› 命令行工具
#commit-message #git-commit #git #conventional-commits #write #generate #cli

应用 rcz

编写提交消息的工具

作者：Cassin01

19 个不稳定版本 (3 个重大更改)

0.4.17 2023年1月31日
0.4.16 2023年1月30日
0.4.15 2022年9月23日
0.3.10 2022年9月22日
0.1.7 2022年9月22日

2495 在 命令行工具 中排名

每月下载量 48 次

MIT/Apache

11KB
180 行

rcz

基于 Conventional Commits 的提交消息编写工具
灵感来源于 git-cz

GitHub CI

安装

cargo install rcz

示例

# bash
function gitz() {
  local output
  if output=$(rcz); then
    git commit -m "${output}"
  else
    echo "Err: failed to generate a commit message"
  fi
}

或

.gitconfig

[alias]
  cz = "!gitz() { if local output= ...}; gitz"
gif

gif

配置

配置文件将自动生成在

  • Linux: ~/.config/rcz
  • Windows: {FOLDERID_RoamingAppData}\rcz
  • Mac OS: ~/Library/Preferences/rs.rcz
默认配置 
format = '''
{type}: {subject}'''

[[types]]
description = 'A bug fix'
value = 'fix'
emoji = '🐛'

[[types]]
description = 'A new feature'
value = 'feat'
emoji = '✨'

[[types]]
description = 'Changes that introduces a breaking API change'
value = 'BREAKING CHANGE'
emoji = '💥'

[[types]]
description = 'build system or external dependencies'
value = 'chore'
emoji = '🛠️'

[[types]]
description = 'CI related changes'
value = 'ci'
emoji = '💫'

[[types]]
description = 'Documentation only changes'
value = 'docs'
emoji = '✏️'

[[types]]
description = 'Changes that do not affect the meaning of the code'
value = 'style'
emoji = '💄'

[[types]]
description = 'A code change that neither fixes a bug nor adds a feature'
value = 'refactor'
emoji = '🧹'

[[types]]
description = ' A code change that improves performance'
value = 'perf'
emoji = '🚄'

[[types]]
description = 'Adding or correcting tests'
value = 'test'
emoji = '🧪'

格式

以下是你可以在格式中添加的所有部分。

  • {类型}
  • {表情}
  • {描述}

⚠️ 双括号（{{echo 'foo'}}，{{date}} 等）被视为 shell 脚本。

其他字符串（{body}，{footer}，{header} 等）被视为自定义输入。
字符串用作提示信息。

有时你可能没有范围，并且必须删除括号。如果范围为空格，则完全删除括号。 #6

以下是一个自定义示例。

format = '''
{type}{scope}: {emoji}{subject}
{body}
{footer}'''

依赖项

~1.2–9.5MB
~78K SLoC