Skip to content

samturrell/gitprefix

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Mar 9, 2020
cc3c2ec Β· Mar 9, 2020

History

18 Commits
Mar 9, 2020
Mar 9, 2020
Jan 26, 2020
Mar 9, 2020
Jan 26, 2020
Mar 9, 2020
Jan 26, 2020
Jan 26, 2020

Repository files navigation

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

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published