validate-branch-name

中文文档

Git branch name validator.

Description

validate-branch-name can be used through command line directly. When using with Husky, you should make sure husky version >= v1.0.0.

Install

1# local install
2$ npm i validate-branch-name -D
3
4# global install
5$ npm i validate-branch-name -g
6

Usage

Use through command line

1
2npx validate-branch-name
3
4# test target branch name
5npx validate-branch-name -t test/branch/name
6
7# define regexp to test branch name
8npx validate-branch-name -r regexp -t test/branch/name
9
10# use -h for more usage detail
11npx validate-branch-name -h
12

Use with husky

First way:

Configure hooks and pattern using package.json.

1// {app_root}/package.json
2{
3  "husky": {
4    "hooks": {
5      "pre-commit": "npx validate-branch-name"
6    }
7  },
8  "validate-branch-name": {
9    "pattern": "^(master|main|develop){1}$|^(feature|fix|hotfix|release)\/.+$",
10    "errorMsg": "your own error message"
11  }
12}

Second way:

Define pre-commit file under .husky directory.

1
2#!/bin/sh
3. "$(dirname "$0")/_/husky.sh"
4
5# validate branch name before commit
6
7npx validate-branch-name 
8

We have set pattern and errorMsg by default, but you can still defined them as you like.

Default pattern: ^(master|main|develop){1}$|^(feature|fix|hotfix|release)/.+$

Example: feature/test/pattern-test would be passed.

Available patterns:

• ^(feature|fix|hotfix|release)/.+ - branch has to start with feature/, fix/, release/ or hotfix/

• (feature|release|hotfix)/(JIRA-\d+) - it should look like feature/JIRA-1234

• (feature|release|hotfix)/(JIRA-\d+/)?[a-z-]+ - it should look like feature/branch-name or include JIRA's code like feature/JIRA-1234/branch-name

• custom patterns, visit regex.

You can also use .validate-branch-namerc, .validate-branch-namerc.json, .validate-branch-namerc.yaml, .validate-branch-namerc.yml, .validate-branch-namerc.js, .validate-branch-namerc.cjs, validate-branch-name.config.js or validate-branch-name.config.cjs file to define config.

Questions & Suggestions

Please open an issue here.

License

MIT