git-tidier

git-tidier is a tool for cleaning up git branches.

• 中文文档 README_zh

Features

• Multiple modes supported: interactive mode, custom regular matching mode, and all in mode
• By default, the recently used branch and the main branch are protected. Check whether the working directory needs to be cleaned up.
• try to clear the local remote branch ( support v1.2.0+)
• Support setting protection branch (support v1.4.0+)
• minimum node version required
  • 1.2.+ >= 18.0.0
  • 1.0.+ >= 16.0.0

usage

Install

$ npm install -g git-tidier
# help
$ git-tidier --help
$ git-tidier --version
# uninstall
$ npm uninstall -g git-tidier

Before Use

Note: Deleting a branch is a very dangerous thing, please ensure that the current warehouse work has been completed, carefully check the prompt information

good development habits are

• any branch remains clean
• Before switching branches each time, do not have legacy commits or stash to prevent forgetting.

How do I check if a branch is active?

$ git branch --sort=committerdate

check

check if current git needs cleanup

$ git-tidier check

# protect the nearest activity 3 branches
$ git-tidier check -n 3

clear

• To ensure that branches are not deleted by mistake as much as possible, the git-tidier ignores the main branch, the current branch, and the three most recently active branches by default (the default behavior can be overridden by configuration)
• git-tidier deletes the local branch and the remote branch corresponding to the remote origin by default
• If the deletion is unstable, it can be set to git-tidier clear -n 5 . Do you need to clear it on the premise of keeping the latest 5 branches?

InteractionMode

$ git-tidier clear
# or
$ git-tidier clean -i

CommandMode

# Delete local branches only, remote branches with the same name are deleted by default
$ git-tidier clear -l

# delete all branches except the protection branch
$ git-tidier clear -a

# force delete. If there are unmerged commits in this branch, they will also be deleted successfully.
$ git-tidier clear -f

# Regular matching pattern support js regular expression custom search branch
# Delete all branches starting with FE-
$ git-tidier clear -e -p '/FE-.*/'
# The regular matching pattern also protects the main branch if you want to remove all set -n 0
$ git-tidier clear -e -p '/FE-.*/' -n 0

• clean configuration

# Modify the remote name ori (the default remote name origin)
$ git-tidier clear -r ori

# ignore dev when cleaning develop branch
$ git-tidier clear -g dev develop

# The number of protected branches is 5, and the default number is 3.
$ git-tidier clear -n 5

Contributing

We welcome community contributions to this project.

Please read Contributor Guide for more information on how to get started.

请阅读有关 贡献者指南 以获取更多如何入门的信息