Introducing mock-my-commit tool because your 'fixed stuff' commit messages clearly needed a reality check. Powered by the Mistral text generation model API, this tool ensures that no matter how lazy your commits are, you'll get the judgment you deserve🤐.

---

Installation

option 1: DOWNLOAD

option 2:

Required

• Go (version 1.22 or higher): Go installation guide
• Mistral API Key: Mistral API Keys console

For Linux, Mac OS and Windows

go install github.com/Kshitiz-Mhto/mock-my-commit@latest

---

Features

• Automated Validation: Enforces Git commit message best practices before commits are registered.

• Cross-Platform Support: Supports Linux, Mac and Windows integration.

• Sarcastic Reviews: Generates passive-aggressive feedback using Mistral's API for poorly crafted messages.

• Seamless Integration: Functions as a Git commit-msg hook to validate messages within your existing workflow.

---

Project: mock-my-commit

This project, mock-my-commit, is built using the Go programming language. Below is a list of the commands offered by this tool.

Demo

---

Brief Command Screenshot

setup-API-key

install

run-hook

---

Technologies Used

• cobra – CLI framework for handling commands.
• term – Terminal handling utilities.
• emoji – For adding emoji reactions to roasts.
• terminfo – Terminal capabilities information.
• mistral-go – API client for interacting with the Mistral text generation model.
• gookit/color – Colored terminal output.

---

Flowchart

setup flow-diagram

---

Local setup

setup for Linux OS

Prerequisites

• Go (version 1.22 or higher): Go installation guide.
• Make: Install using (e.g., sudo apt-get install make on Debian/Ubuntu).
• Mistral API Key: Mistral API Keys console.

Installation

1. Navigate to the project repo and run

make build

2. Create a symlink using

sudo ln -s /path/to/bin/mock-my-commit /usr/local/bin/mock-my-commit

3. Test the Executable

mock-my-commit

4. View the Manual

mock-my-commit -h

Setup for macOS

Prerequisites

• Go (version 1.22 or higher): Install via Homebrew (brew install go) or official package
• Make: Pre-installed with Xcode Command Line Tools (run xcode-select --install if missing)
• Mistral API Key: Get from Mistral console

Installation

1. Build the binary

   make build

   For M1/M2 Macs: Ensure Rosetta isn't interfering with ARM builds

2. Create system symlink

   sudo ln -s $HOME/path/to/project/bin/mock-my-commit /usr/local/bin/mock-my-commit

Verification

mock-my-commit --version  # Check installation
mock-my-commit -h         # View manual

setup for Window OS

Prerequisites

• Go (version 1.22 or higher): Go installation guide
• Mistral API Key: Mistral API Keys console

Installation

1. Build the Project
   Open PowerShell in the project directory and run:

   go build -o bin/mock-my-commit.exe main.go

2. Add to System PATH
   Either:

   • Move the bin/mock-my-commit.exe to a directory already in your PATH, or

   • Create a symlink using:

     # PowerShell (Admin)
     New-Item -ItemType SymbolicLink -Path "$env:SYSTEMROOT\System32\mock-my-commit.exe" -Target "C:\full\path\to\bin\mock-my-commit.exe"

3. Test the Executable

   mock-my-commit

4. View the Manual

   mock-my-commit -h

Note:

• For symlinks, run PowerShell as Administrator
• Replace C:\full\path\to\bin with your actual binary path
• $env:SYSTEMROOT/%SYSTEMROOT% automatically resolves to C:\Windows (or system root)

---

Makefile Documentation

This Makefile simplifies building, testing, installing, and cleaning the mock-my-commit project.

Variables

• BINARY_NAME: Output binary name (mock-my-commit).
• OUTPUT_DIR: Directory for the built binary (bin).
• MAIN_FILE: Entry point of the Go project (./main.go).
• INSTALL_DIR: Installation path ($GOBIN or $HOME/go/bin).

Targets

The Makefile has the following targets that automate the build process:

build

• Description: Builds the binary from the main Go file and outputs it to the bin directory.

make build

test

• Description: Runs the tests for the project using go test.

make test

install

• Description: Builds the project and installs the binary to the GOBIN directory.

make install

clean

make clean