A NodeJS-based command line tool to clean up unused git branches

Table of content

• 1. Usage
  • 1.1. Install the tool
  • 1.2. How to use
• 2. Contribution
  • 2.1. Setup
  • 2.2. Develop
  • 2.3. Other development utilities
  • 2.4. Maintenance guideline

---

1. Usage

This tool is a command line executable, please use Terminal application

1.1. Install the tool

1. Install NodeJS. The minimum version supported is v8.x
2. Install the command line tool

npm install -g @duylam/git-branch-clean

1.2. How to use

1. cd to directory of a git repository
2. To see the usage guideline

git-branch-clean --help

3. Below are some commands for common clean-up cases

• To remove unused branches in local repo

git-branch-clean

• To remove unused branches in remote repo named origin

git-branch-clean -r origin

2. Contribution

2.1. Setup

• Install NodeJs v8.17.0

2.2. Develop

1. Run npm install to install dependencies.
2. Run npm start to begin watching file changes and auto build to build folder.
3. Temporarily create an variable for the path of this repo

export GBC_DIR=`pwd`

4. cd to another dir having git repo
5. Execute the tool

DEBUG=git-branch-clean node $GBC_DIR/build/index.js --help

6. Code :)

2.3. Other development utilities

• npm run format to format the code nicer
• npm run lint to run static code checker
• npm run update-toc to update the Table of Content in this file
• To create dummy local and remote (named origin) git branches for coding, run the script ./scripts/create-dummy-branches.sh at any git repo

2.4. Maintenance guideline

• To publish new version on NPM, create a Github Release with prefix v at git tag e.g. v0.1.0
• All changes in main branch are required to have PR