sdttttt / gcr Goto Github PK

View Code? Open in Web Editor NEW

28.0 2.0 6.0 368 KB

📑 Compact specification git commit tool, it has a variety of practical small functions. (Inspired by git-cz on Node.js)

Home Page: https://crates.io/crates/grc

License: The Unlicense

Rust 100.00%

git rust commitizen git-cz commit-message commitlint cli

gcr's Introduction

GRC

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:

cargo install grc

Release Package

Go to RELEASE, download one you like.

From Source

Please Run:

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

Using

after the tools install, run command in your repository:

grc

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

//Add all files
grc -a .

// Add specified file
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.

# 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!"
]

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!

gcr's People

Contributors

Stargazers

Watchers

Forkers

public-fork forsworns caedmonx xaydbayeck helloworldgnu supbose

gcr's Issues

A more beautiful error prompt.

failed to install

encounter an error when i run cargo install grc

error: failed to compile `grc v1.2.0`, intermediate artifacts can be found at `/tmp/cargo-installBHdw34`

Caused by:
  failed to select a version for the requirement `zeroize = "^0.9.3"`
  candidate versions found which didn't match: 1.3.0, 1.2.0, 1.1.1, ...
  location searched: crates.io index
  required by package `dialoguer v0.7.1`
      ... which is depended on by `grc v1.2.0`

[Feature request] Create a template gcr.toml when the install is made with cargo

Pretty self-explanatory. Another idea is to force creation of it in a default folder, like ~/.config/grc/gcr.toml

impl core feature:

specifications Commit.

I package it on AUR

link is https://aur.archlinux.org/packages/git-grc/

Add more unit tests.

I'm really not very good at TDD development...

Unit test coverage to 15%

Did not check type.

Maybe I missed part of it. If the type of the grc.toml clock does not use symbols to separate types and descriptions, something unexpected will probably happen.

Specify the configuration file with command line parameters.

Currently, GRC locks grc.toml as a configuration file.

About `push` plug output "Failed to authenticate SSH session: "

I have updated this in the plugin description. Details: https://github.com/sdttttt/gcr/tree/master/src/plugins

[Bug Report] 1st commit after git init failed

Steps to reproduce

git init
touch README.md, git add README.md
grc, then failed

❯ grc
✔ Which scope? (Optional) ·
✔ Commit Message ? · 1st commit
✔ Provide a longer description? (Optional) ·
✔ PR & Issues this commit closes, e.g 123: (Optional) ·
GRC: feat: 1st commit
GRC: reference 'refs/heads/master' not found

Environments

grc version: v1.0.0 from release page. grc --version GRC 1..0.0.beta.1
git version: 2.30.1
OS: macOS 10.14.6

Feature: Settings from the outside.

Add configuration files belonging to grc to the warehouse file, through which some actions of grc can be changed.

An action that can be changed through a configuration file.

Customize the submission type and scope.

[Enhance] grc hook experience is not good.

This problem will be solved, such as the hook cannot be executed on the windows and the execution error is not clear.

CI: Add Binary production workflow for macos.

I noticed that there is a lack of workflow for other platforms.

[Feature Request] Action hooks.

We can add an action hook to implement some additional operations, such as routine unit testing.

They may occur around the COMMIT.

Git already provides these capabilities, but they can be inconvenient to use.
https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks

commits generated by grc are not properly signed

By default, if signingKey is specified in ~/.gitconfig, git will automatically sign the commit using gpg. But when using grc, commits are not signed.

git log --show-signature

My gitconfig:

mgt in ~
❯ cat .gitconfig
[user]
    name = mgt
    email = [email protected]
    signingKey = 7965BF43A2143DD26F1A4850362C4BEE95C1C2DF
[commit]
    gpgSign = true

I've searched git2's document, and I guess it is possible to implement this feature. See https://docs.rs/git2/0.13.17/git2/struct.Repository.html#method.commit_signed .

Pre-hooks may change the tracked files, but not commit changes

Hi, the pre-hooks may change the tracked files, while the gcr won't track these changes.

For example, when cargo fmt is hooked, I observe these:

Here is the configuration:

emoji = true
pre = ["cargo fmt"]
after = []

[Feature] Add reuse commit message.

In some cases, you may want a submission message to be reused over and over again.
(for example, when a locally built dist must be submitted to the warehouse)

More suitable for everyone

考虑到每个人的习惯, 我建议多加一些命令选项.

如下:

grc push <file_name> # 自动Add 该文件到index, 输入commit 信息,自动推送,  如果 file_name 是`.` 那么自动添加所有文件

grc add <file_name> # 自动Add 该文件到index, 输入commit 信息, 如果 file_name 是`.` 那么自动添加所有文件

env GIT_AUTHOR_NAME is not used

I use direnv to export env GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL ... in specific directory to change author and committer. Seems these environment variables are not used.

How temporary is the name?

Hi, your readme/about page mentions that grc is a temporary name. Is it likely to change in the near future?

I am developing a new crate that I'd hoped to use the name grc for. I'm happy to change the name as it's still very much a work in progress but if this will be changing soon I'll leave it as it is.

Thanks and good luck with the project.

incorrect repo name?

gcr or grc ? I'm not pretty sure which one is correct...