Miss any of our Open RFC calls?Watch the recordings here! »

gitprefix

1.0.5 • Public • Published

Gitprefix

Gitprefix is a Git prepare-commit-msg hook for formatting Git commit messages.

Features

  • Automatic task branch prefix (task/, epic/)
  • Emoji prefixing for certain words:
    • fix: 🔧
    • wip: 🚧
    • bug: 🐛
    • refactor: 🔨
    • revert: ⏪
    • pr: 👌
    • initial commit: 🎉
    • responsive: 📱
    • accessibility: ♿️

Usage

Prerequisites

You need to have a git template directory set up. You can do this by creating an empty directory and adding this config to your ~/.gitconfig:

[init]
    templatedir = ~/path/to/your/git-template

Installation

This package is used as an installer for the formatter. To install you can run the following command:

npx gitprefix install

For new git repositories, the hook files wil be added automatically, however for existing projects you can run the following commands to reinitialise:

npx gitprefix init

Updating

If the package is ever updated you can run the following command to pull down the new formatter and overwrite the existing file:

npx gitprefix install --overwrite

Keywords

none

Install

npm i gitprefix

DownloadsWeekly Downloads

2

Version

1.0.5

License

MIT

Unpacked Size

5.95 kB

Total Files

8

Last publish

Collaborators

  • avatar