https://github.com/santerijps/git-commit-conv

Generate a git commit-msg hook easily to enforce a strict commit message format.
https://github.com/santerijps/git-commit-conv

commit-message git vlang

Last synced: 2 days ago
JSON representation

Generate a git commit-msg hook easily to enforce a strict commit message format.

• Host: GitHub
• URL: https://github.com/santerijps/git-commit-conv
• Owner: santerijps
• Created: 2022-06-30T19:19:59.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-07-01T10:49:00.000Z (over 2 years ago)
• Last Synced: 2023-03-05T05:34:47.281Z (over 1 year ago)
• Topics: commit-message, git, vlang
• Language: V
• Homepage:
• Size: 7.81 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# git-commit-conv

Generate a git commit-msg hook easily to enforce a strict commit message format. Simply run the executable in your git repository to add the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard to the commit-msg hook.

You can also provide a path to the git repository and a custom RegEx pattern to check the commit messages against.

## Usage

```txt

git-commit-conv 0.2.0

-----------------------------------------------

Usage: git-commit-conv 

   or: git-commit-conv --status

   or: git-commit-conv --regex '^TICKET-\d+: .+$'

   or: git-commit-conv --path /path/to/repo --regex '^TICKET-\d+: .+$'

Description: Generate a git commit-msg hook quickly!

This application does not expect any arguments

Options:

  -r, --regex       The RegEx pattern to compare the commit message to. Defaults to conventional commits.

  -p, --path        Path to a git repository where to add the hook. Defaults to current directory.       

  -r, --reset               Reset (remove) the commit-msg hook.

  -v, --verbose             Print program messages.

  -s, --status              Get the current commit-msg hook, if any.

  -i, --install     Install a RegEx pattern with a name.

  -u, --uninstall   Uninstall a RegEx pattern by name.

  -n, --name        The name of the installed RegEx pattern to use.

  -l, --list                List all installed RegEx patterns.

  -h, --help                display this help and exit

  --version                 output version information and exit

```