CommitWeave: A Modern CLI Tool for Beautiful Git Commit Messages ✨

Table of Contents

• Overview
• Features
• Installation
• Usage
• Configuration
• Supported Emojis
• Contributing
• License
• Contact

Overview

CommitWeave is a modern command-line interface (CLI) tool designed to help developers write smart, consistent, and beautiful git commit messages. It leverages the Conventional Commits specification, supports emoji usage, and offers optional AI assistance to streamline your commit process.

By using CommitWeave, you can enhance your commit history, making it more readable and meaningful. The tool is perfect for teams and individual developers who want to maintain high-quality commit messages effortlessly.

Features

• Conventional Commits: Follow the Conventional Commits standard for structured commit messages.
• Emoji Support: Add emojis to your commit messages for better visual representation.
• AI Assistance: Optionally use AI to generate commit messages based on your changes.
• Customization: Tailor the tool to fit your workflow and preferences.
• Integration: Works seamlessly with existing git workflows and tools like Husky and Commitizen.
• Lightweight: Minimal setup required, allowing you to focus on coding.

Installation

To install CommitWeave, you can use npm or npx. Open your terminal and run the following command:

npm install -g @typeweaver/commitweave

Or, if you prefer using npx, you can execute it directly without installation:

npx @typeweaver/commitweave

After installation, you can start using CommitWeave right away.

Usage

Using CommitWeave is straightforward. Simply run the command in your terminal:

commitweave

You will be prompted to enter your commit message. Follow the prompts to create a well-structured commit message. If you choose to use AI assistance, CommitWeave will analyze your changes and suggest a message.

Example

Here’s a quick example of how to use CommitWeave:

1. Run the command:

   commitweave

2. Follow the prompts to add your message type, scope, and description.

3. CommitWeave will generate a commit message that follows the Conventional Commits format.

Command Options

• --help: Display help information.
• --version: Show the current version of CommitWeave.

Configuration

You can customize CommitWeave to fit your development environment. Configuration options include:

• Default Emoji: Set a default emoji for your commit messages.
• Message Format: Adjust the format of the generated commit messages.
• AI Settings: Enable or disable AI suggestions.

To configure CommitWeave, create a configuration file named .commitweave.json in your project root:

{
  "defaultEmoji": "✨",
  "messageFormat": "{type}({scope}): {description}",
  "useAI": true
}

Supported Emojis

CommitWeave supports a variety of emojis to enhance your commit messages. Here’s a selection of commonly used emojis:

• ✨ feat: A new feature
• 🐛 fix: A bug fix
• 📚 docs: Documentation only changes
• 🎨 style: Changes that do not affect the meaning of the code
• ⚡ perf: A code change that improves performance
• ✅ test: Adding missing tests or correcting existing tests

For a complete list of supported emojis, please refer to the Emoji Cheat Sheet.

Contributing

We welcome contributions to CommitWeave! If you would like to help improve the tool, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them.
4. Push your branch to your forked repository.
5. Open a pull request to the main repository.

Please ensure your code follows the project's coding standards and includes tests where applicable.

License

CommitWeave is licensed under the MIT License. See the LICENSE file for more information.

Contact

For questions, feedback, or support, please reach out to the repository owner or open an issue in the GitHub repository.

You can also check the Releases section for the latest updates and versions.

For the latest release, visit Download Latest Release to download the latest version and execute it.

Happy committing!