yazan98 / commiter

Ruby Cli To Block Git Commits if you wrote Bad Messages

Commiter

Description

Commiter is a Cli Written in Ruby To Ask some Questions about how you want to write the commit message validation before write any commit and if this commit is not matching the commiter configuration file it will reject the commit and kill the process

Project Development

This Project Designed Like this to Match any Project or language i will work on for this reason it has External files should be inside Hooks Manually to match any type of Projects and it's not connected to a specific language configuration

The Problem

In each git Repository when you initialize the Project you dont have Rules to make All Developers inside this Project Follow same way in Commit Messages and in the Future if you cant find any key inside the messages to see the history you will never know how this feature implemented like this until you deep dive into it because you dont have the main reason about this area you just found the commit message (fix) and this is not a commit message :D so with this configuration all the team will have same commit rules and if someone is not following this rules the commit will be rejected

Screenshots for Validation

1. Ticket Number Validation

The Use case Here is when i work on Large Project i Use This Technique to Connect Everything with a Ticket Number so i can return whenever i want inside History and know exactly this change for any ticket

2. Black list Validation

The Use case Here is when i work on a repo sometimes i write Dummy Messages and this will remind me if i wrote same message again :D

3. Regex Expression Validation

The Use case Here is a Customized way to Put any Pattern you want if it not already Supported

4. Subject and Content Validation

The Use Case Here some Project dont have Task Management Project so There is no Ticket Number Here So this Technique Will be Good when you Write Subject : Content Meaningful Message

Validations Supported

1. Ticket Number
2. Black List Words
3. Regex Expression
4. Subject : Content

Installation

1. Ruby Required
2. Bundler To Fetch Gem

Include in Another Supported Ruby Project

1. Create File in your Root Directory inside The Project (Gemfile)
2. Add This Line at the First

source 'https://rubygems.org'

3. Add this Line inside This File RubyGem Link

gem 'commiter', '~> 1.0.0'

4. Run this Commands

gem install commiter
bundle install
bundle package

6. Copy commiter gem file From Vendor Directory to your Project

Quick Installation

If you dont wanna use gem file you can copy the files and Edit the Config json File from result folder into you .git/hooks folder inside your git repository you will find variables described in table section

In this Step you dont need to Edit Your Project Source Code you just copy the Files to git Configuration

Key Name	Description
is_enabled	Decide if commit command will check the validation or not
ticket_number_example	What is the Ticket Number Key like SW-{#} The {#} is the Dynamic Number Value
generated_style	You Have 3 Options To Validation (t -> Ticket Number) / (b -> Black List Words) / (r -> Regex Expression)
regex_input	The Regex String to match Message with it if the generated style (r) is Selected
black_list_words	The Black list words Blocked

Cli

This Project is a Command line Interface to Generate this File inside your git file If you want to Install the Cli Clone this Repo then install ruby and run this command inside the Project

rake install -g

The Cli should be started

Todo List

1. Support Restore Point In Cli To Generate Git Hooks from Config Json File
2. Support 2 Types in the same time in Validations like Regex and Black list
3. Run Command Before push commit like Code Analysis Then Execute Commit Message Validation