XGIT CLI

Git Flow and Conventional commit CLI Tool.

Overview

A couple of command tools for managing git commits and branches following a specific flow model.

Getting Started

1. Install the package globally

npm install -g @olvrcc/xgit@latest

2. Initialize the configuration file in your project:

xgit init

This creates an xgitrc.json file with default values. Update the project field with your Jira project slug, and customize other options as needed:

{
  "project": "YOUR_JIRA_PROJECT_SLUG <- this is the only required field",
  "feat": "Set the value you'd want to prefix for a 'feat' branch",
  "bug": "Set the value you'd want to prefix for a 'bug' branch",
  "hotfix": "Set the value you'd want to prefix for a 'hotfix' branch",
  "release": "Set the value you'd want to prefix for a 'release' branch",
  "docs": "Set the value you'd want to prefix a for a 'docs' branch",
  "ticketSeparator": "Character to separate ticket from branch name (defaults to '_')",
  "descriptorCase": "Text case for branch descriptor: 'snake', 'pascal', 'camel', 'kebab' (defaults to 'snake')"
}

Using the CLI:

Available Tools & Usage:

Initialize Configuration

Create the default xgitrc.json configuration file:

xgit init

This command creates a configuration file with all default settings. Remember to update the project field with your actual Jira project slug.

Create Branch

It's designed to assist with creating branches that follow the git flow method along with Jira or similar integration, given a Jira project code of PROJ, you can do the following: Each branch type can be set using the following flags:

• -f for feature
• -b for bug
• -h for hotfix
• -r for release
• -d for docs

Command: 'branch' or 'b':

 $ xgit b <branch type flag> <task number> <branch name>

Examples:

 $ xgit b 123 "a unique task" // PROJ-123_a_unique_task <- not setting a flag will not prefix the branch
 $ xgit b -f 123 "a unique task" // feature/PROJ-123_a_unique_task
 $ xgit branch -h 123 "a unique task" // hotfix/PROJ-123_a_unique_task

Configuration Options:

The separator between ticket and branch name can be customized via ticketSeparator:

• Default (_): feature/PROJ-123_my_branch
• Forward slash (/): feature/PROJ-123/my_branch
• Hyphen (-): feature/PROJ-123-my_branch

The text case for branch descriptors can be customized via descriptorCase:

• snake (default): feature/PROJ-123_my_branch_name
• kebab: feature/PROJ-123_my-branch-name
• camel: feature/PROJ-123_myBranchName
• pascal: feature/PROJ-123_MyBranchName

Committing work

This will help committing work following a conventional commit approach and has a small wizard that walks you through the process.

Command: 'commit' or 'c':

 $ xgit c
 $ xgit commit

Checking out a branch via fuzzy search

You are able to checkout a branch (so long as it's local) using:

xgit f <fuzzy search>

Example:

If you had a branch feat/JIRA-123_some_work, you can check it out without having to type through the feat/JIRA- before autocomplete would kick in. Just do this and you'll check out the branch

xgit f 123

If there is only a single result it will automatically check the branch out If there are multiple branches returned the tool will pop up the list and you can select the branch you want to check out and it'll check it out for you.

License

Include a LICENSE file to specify the licensing terms for your project.