craicoverflow / sailr Goto Github PK

View Code? Open in Web Editor NEW

92.0 2.0 27.0 31 KB

A configurable Git hook for adhering to the Conventional Commit specification

Home Page: https://dev.to/craicoverflow/enforcing-conventional-commits-using-git-hooks-1o5p

License: MIT License

Makefile 7.01% Shell 82.93% Python 10.06%

git githooks conventionacommits bash hacktoberfest

sailr's Introduction

Sailr

Sailr helps you follow the Conventional Commits conventional by installing a configurable commit-msg into your Git projects.

About
Getting Started
Usage

Prerequisites

To use Sailr, you must have jq installed.

Installing

curl -o- https://raw.githubusercontent.com/craicoverflow/sailr/master/scripts/install.sh | bash

Uninstalling

Remove the commit-msg Git hook from your project:

rm <your-project>/.git/hooks/commit-msg

Usage

Once installed, you must run git init in your Git projects to (re)initialize your repository. The hook will look for a configuration file in the following locations (in order):

The root of your Git project.
SAILR_CONFIG: You can set a custom location for your sailr.json config by setting the SAILR_CONFIG environment variable. Example: SAILR_CONFIG=$HOME/.sailr/sailr.json.

{
    "enabled": true,
    "revert": true,
    "length": {
        "min": 1,
        "max": 52
    },
    "types": [
        "build",
        "ci",
        "docs",
        "feat",
        "fix",
        "perf",
        "refactor",
        "style",
        "test",
        "chore"
    ]
}

Note: you can disable Sailr in your project by setting enabled to false in sailr.json.

Unit Testing

Unit tests are written in Python. They are located in ./tests

To run all tests:

make test

sailr's People

Stargazers

Watchers

Forkers

bonfacekilz molnarjani juliabenton angellandros exu henrygessau regalius jvinding austincunningham tharlaw smarcelino-ams doxsch tapsellorg babakoto apollodao sebamontoya kidneyweakx nathanielrn jscarl

sailr's Issues

error even if the regex matches

I implemented the hook and I get an error even it matches.

[Invalid Commit Message]
------------------------
Valid types: build
 ci
 docs
 feat
 fix
 perf
 refactor
 style
 test
 chore
Max length (first line): 52
Min length (first line): 1
Regex: ^[.0-9]+$|build
|ci
|docs
|feat
|fix
|perf
|refactor
|style
|test
|chore)(\(.+\))?: .{1,52}$
Actual commit message: "refactor(async): almost done"
Actual length: 29

and I also dont get it why my regex has line breaks in it

I am on windows

Add more tests

Add CircleCI or GitHub Actions

Add basic unit tests

It would be nice to have some basic unit tests

Add a check before executing the hook to ensure that `jq` is installed on the developer's device

What

A prerequisite for Sailr to work is that the developer has jq installed.

There should be a pre-check in the script to see if jq is installed, and exit with a warning/message if it is not.

Something like the following sudo code.

if jq is not installed
	print "`commit-msg` hook failed. Please install jq."
	exit
endif

Does not work when using VSCode as editor

When I commit something, my VSCode editor shows up, I write a message according to the conventional commits page, save and exit but I get this error:

$ git commit -a

[Invalid Commit Message]
------------------------
 choretores: build
Max length (first line): 52
Min length (first line): 1

Regex:
Actual commit message: ""
Actual length: 1

Before installing Sailr I could commit without any issue