GRC

一个紧凑的 Git 提交规范工具，用 Rust 编写，具有多种实用的小功能。

类似于 git-cz，GRC 将帮助您获得更好的 git 提交体验。

安装

您可以通过以下方式安装 grc

从 crates.io

grc 依赖项很少，您可以快速轻松地构建它！

请运行

cargo install grc

发布包

转到 RELEASE，下载您喜欢的版本。

从源代码

请运行

cargo install --git https://github.com/sdttttt/gcr.git

使用

在工具安装后，在您的存储库中运行命令

grc

GRC 还可以自动帮助您将文件添加到索引。

//Add all files
grc -a .

// Add specified file
grc -a <filename>...

GRC 配置文件

提示：此功能支持版本 0.9.0 以上

您可以在仓库根目录的 grc.toml 配置文件中追加自定义提交类型：从 0.9.1 版本开始，grc 使用 ~/.config/grc/grc.toml 作为默认配置文件。

# A colon separates the type from the description of the type.
type = [
    "type: this is new commit type."
]

# Starting with **1.0.0**, grc can enhance your submission with the `--emoji` command line argument.
emoji = true

# You can also use `overwrite_emoji` to enhance custom submission types or override basic submission types in GRC.
overwrite_emoji = [
    "deps:🚕", # Appends an emoji to a custom submission type
    "test:🚗"  # Test is a GRC built-in submission type that you can override.
]


# [Beta] Starting with **1.2.0**, Added two new options to the configuration file, `pre` and `after`, which are similar to githook. Here you can enter the actions of the commands before and after COMMIT.
pre = [
"cargo test"
]

after = [
"echo Ok!"
]

插件

插件是 1.1.0 版本中添加的新功能。有关插件和使用的详细信息，请参阅 此处。

想法

如果您有任何新的想法，欢迎与我交流。

GRC 仓库使用 GRC 进行提交！