GitPretty

What it does

gitpretty enhances Git history by automatically adding emojis and formatting commit messages. It transforms simple descriptions into standardized, visually appealing commits using predefined types like "feat" (✨), "fix" (🐛), or "docs" (📝). The tool supports both quick commits with short descriptions and smart commits for more detailed, conventional commit message structures.

When to use it

• Standardize team commit messages: Enforce a consistent style across all project contributors.
• Improve readability of Git logs: Make browsing the history easier by visually differentiating commit types.
• Quickly create formatted commits: Streamline the commit process with automated formatting and emoji insertion.
• Generate conventional commit messages: Facilitate automation in CI/CD pipelines that rely on structured commit data.

Key capabilities

• Automatic emoji insertion based on commit message content.
• Support for quick commits using a simple description string.
• Smart commit functionality to generate detailed, conventional commit messages (e.g., feat(auth): add user authentication).
• Predefined commit types with associated emojis (feat, fix, docs, style, refactor, perf, test, chore, ci).
• Dry-run mode for previewing formatted commits without actually committing.

Example prompts

• "Stage all files and commit with the message 'add user dashboard'."
• "Stage specific files and commit with a fix login bug description."
• "Create a smart commit adding a new feature to the authentication module."

Tips & gotchas

• The script requires cloning the gitpretty repository to your home directory or another accessible location.
• Ensure that the ~/.gitpretty/scripts/emoji-commit.sh and ~/.gitpretty/scripts/smart-commit.sh scripts are executable (e.g., using chmod +x).