项目作者: sdttttt

项目描述 :
Semantic git commits tool. use rust to rewrite the main features of git-cz. and GRC also has its own unique features.
高级语言: Rust
项目地址: git://github.com/sdttttt/gcr.git
创建时间: 2020-09-09T10:54:41Z
项目社区:https://github.com/sdttttt/gcr

开源协议:MIT License

下载


GRC

GRC
Rust
Release
Codacy Badge
codecov

Compact specification git commit tool, written in Rust, it has a variety of practical small functions.

Similar to git-cz, GRC will help you to provide a better git commit experience.

Install

You can install grc in the following ways:

From crates.io

grc has very few dependencies, and you can build it very quickly and easily!

Please Run:

  1. cargo install grc

Release Package

Go to RELEASE, download one you like.

From Source

Please Run:

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

Using

after the tools install, run command in your repository:

  1. grc

GRC can also automatically help you add files to the index.

  1. //Add all files
  2. grc -a .
  3. // Add specified file
  4. grc -a <filename>...

GRC config file

TIP:
This feature is supported above version 0.9.0

You can append custom commit types in the grc.toml configuration file at repo root directory:
Starting with 0.9.1, grc using ~/.config/grc/grc.toml as the default configuration file.

  1. # A colon separates the type from the description of the type.
  2. type = [
  3. "type: this is new commit type."
  4. ]
  5. # Starting with **1.0.0**, grc can enhance your submission with the `--emoji` command line argument.
  6. emoji = true
  7. # You can also use `overwrite_emoji` to enhance custom submission types or override basic submission types in GRC.
  8. overwrite_emoji = [
  9. "deps:🚕", # Appends an emoji to a custom submission type
  10. "test:🚗" # Test is a GRC built-in submission type that you can override.
  11. ]
  12. # [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.
  13. pre = [
  14. "cargo test"
  15. ]
  16. after = [
  17. "echo Ok!"
  18. ]

Plug (experimental)

This feature is not enabled in the default version and needs to be set in the build. Add --features plug to the cargo build command to enable the plugin.

plug are a new feature added in 1.1.0. Details of the plug-in and usage can be found here.

IDEA

If you have any new ideas, you are welcome to talk to me.

GRC repo is used GRC to commit!