njakob / breeze

Git Flow CLI wrapper for NPM based products

breeze

Git Flow CLI wrapper for NPM based products

Tired of typing long command lines, naming your hotfix and release branches or constantly checking the state of your repository before finishing branches? Breeze is a tool made for you!

Breeze is a wonderful simple CLI wrapper that would help you to deal with common repetitive tasks that must be done in an NPM based product. It also use a configuration file that can be checked-out in your repository to make sure all contributors use the same Git Flow parameters.

Features

• Shared configuration through .breezerc file
• New release or new hotfix automatically bump package version
• Finishing a branch automatically perform the right operation according to the branch prefix

Installation

With NPM:

$ npm install @njakob/breeze

With Yarn:

$ yarn add @njakob/breeze

Usage

Initialization

In order to initialize Breeze for your team, use the following command:

$ breeze init

This would create an initial .breezerc configuration file that you can checkout in your repository. Besides Git Flow parameters, bump commits for releases and hotfixies can also be configured through this file.

.breezerc

{
  "branch": {
    "master": "master",
    "develop": "develop"
  },
  "prefix": {
    "feature": "feature/",
    "release": "release/",
    "hotfix": "hotfix/",
    "version-tag": ""
  },
  "commit": {
    "release": "Bump to %s",
    "hotfix": "Bump to %s"
  }
}

Creating branches

For each Git Flow operation, a corresponding command is available in the CLI. As shown in the following example, only creating a feature requires a name. Both features and hofixes would automatically use the bumped version as name.

$ breeze feature <name>
$ breeze release {minor|major}
$ breeze hotfix

Finializing branches

Finishing a branch would automatically apply the correct operation regarding the prefix of the branch.

$ breeze finish

Licences

njakob/breeze is licensed under the MIT License.

breeze's Issues

Unable to initialize

It is currently impossible to initialize a repository with breeze init since it generates an error.