sema

sema - semantic commit tool

This is a simple command line tool inspired by this gist about semantic commit messages. In short, it proposed to use labelled commit messages that derive their format from Angular's commit rules.

The sema command will help you follow these guidelines with no effort on your part to memorise labels or double-check things.

UPDATE: sema is now in AUR! Install it with pamac (GUI) or yay as follows:

yay -S sema

Format

Each commit message is supposed to be formatted in the following way:

TYPE(SCOPE): MESSAGE

Where SCOPE tells you about the scope of changes, MESSAGE summarises those in a concise way, and TYPE is a short label from the following:

• feat: new feature for the user
• fix: bug fix for the user
• docs: changes to the documentation
• style: formatting with no production code change
• refactor: refactoring production code
• test: adding missing tests, refactoring tests
• perf: performance improvements
• chore: updating grunt tasks

You can see the list of these labels with explanations using sema --more.

Installation

From AUR (for Arch-based Linux)

yay -S sema

Using the go tool

go install github.com/sharpvik/sema  # => $GOPATH/bin/sema

NOTICE: Both installation methods put sema binary into your $GOPATH/bin so make sure that your $GOPATH/bin is in $PATH!

HACK: After the default installation, the sema command will be available. However, if you rename that binary file to git-sema, you will be able to use it as if it's part of the default git tools:

git sema

Usage

Overview

sema --help  # if you need a usage hint
sema --more  # see all label descriptions
sema --add   # run 'git add .' before all else
sema --push  # run 'git push' after sucessful commit
sema         # commit changes in current repo

NOTE: the --push and --add flags can be combined, which will be equivalent to running the following:

git add .
git commit -m "feat(*): commit description"
git push

Commit Hooks

Sometimes we'd like to run a script before every commit. For example, I often forget to run go fmt ./... before publishing changes. To combat this issue, introducing commit hooks.

Every time you run sema, it will look for a file called hooks.sema in the current working directory and attempt to execute it (make sure to give executive permissions to the hooks file).

Of course, using hooks.sema is optional and its absence won't break anything. For a basic example of such a file, take a look at hooks.sema.

Some Screenshots