momox

A CLI tool for git operations, starting with squash for sprint branches.

Description

momox is a command-line tool designed to perform various git operations. Currently, it supports squashing commits on sprint feature branches into a single commit. It automatically determines the base branch based on the sprint date and performs a safe squash operation. Future versions will include additional commands like debug, monitor, etc.

Installation

Install globally via npm:

npm install -g momox

Usage

Navigate to your git repository and run:

npx momox squash [commit-message]

Requirements

• Your current branch must follow the format: sprint_YYYYMMDD/feature-name
• The base branch sprint_YYYYMMDD/master must exist on the remote.
• You must be on a feature branch (not the master branch).

Examples

# Squash with default commit message (uses the latest commit message)
npx momox squash

# Squash with a custom commit message
npx momox squash "feat: implement user authentication"

What it does

1. Validates the current branch name format.
2. Derives the base branch from the sprint date.
3. Fetches the latest changes from origin.
4. Pulls the latest changes from the remote branch.
5. Creates a backup branch (e.g., branch_backup_20251230_123456) from the current state and pushes it to origin for safety.
6. Finds the merge-base between your branch and the base branch.
7. Stashes any uncommitted changes if present.
8. Resets softly to the merge-base.
9. Commits all changes with the specified message.
10. Restores stashed changes if any.
11. Pushes the squashed branch with force-with-lease.

License

MoMo