Shiva shield

git-flow standards validator

Provides a binary that can be used as a git-hook to validate branch names and commit messages according to git-flow prior to pushing upstream.

Validate branch name:

$ git rev-parse --abbrev-ref HEAD
Output: features/dev-reg
  
$ git push
Output:
Error:
 Branch name is not allowed by pattern ^(develop|dev|realese)|^(feature|bugfix|hotfix)/[A-Za-z]+-\d+.
 Branch name: features/dev-reg

Validate commit message:

$ git commit -m "Add readme"
Output:
Error:
 Commit message is not allowed by pattern '^[A-Za-z]+-\d+'.
 Message: Add readme

Installation

$ npm install shivas husky@next --save-dev

Update packages.json

{
...
  "husky": {
    "hooks": {
      "commit-msg": "shivas-msg",
      "pre-push": "shivas-bn"
    }
  }
}

• Use husky to setup pre-push and commit-msg git hooks.

Features

• Validate branch name according to default git-flow format. pattern: [^(develop|dev|realese)|^(feature|bugfix|hotfix)/[A-Za-z]+-\d+].
• Validate commit message according to default git-flow format. pattern: [^[A-Za-z]+-\d+].
• Prevent pushes to certain branches such as master or staging.
• Completely customizable, for Regex validation.

Usage

Options

Define options in husky hook package.json file (values display below are the default values):

{
...
  "husky": {
    "hooks": {
      "commit-msg": "shivas-msg '^[A-Za-z]+-\\d+'",
      "pre-push": "shivas-bn '^(develop|dev|realese)|^(feature|bugfix|hotfix)\/[A-Za-z]+-\\d+'"
    }
  }
}

Skip commit messages validation:

{
...
  "husky": {
    "hooks": {
      "pre-push": "shivas-bn"
    }
  }
}

prefixes

git-flow branch prefixes allowed.

disallowed

Prevent pushing to certain branches, must be the entire branch name, including prefixes. Prevent commit to certain branches, must be the entire commit message, including prefixes and task number.

License

MIT