CommitIQ

CommitIQ - Smart Commit Message Validator CommitIQ is a VS Code extension designed to enhance commit message quality by enforcing Conventional Commit standards. It validates commit messages in real-time, provides error feedback, and offers auto-fix suggestions, ensuring better version control practices.

🚀 Features ✅ Real-time Commit Validation – Ensures commit messages follow Conventional Commits. 🛠 Auto-Fix Suggestions – Automatically corrects non-compliant messages. ⚠ Detailed Error Feedback – Highlights formatting issues for quick fixes. 📋 Clipboard Copying – Easily copy corrected commit messages. 🚀 Seamless Integration – Works effortlessly within the VS Code workflow.

Here’s a detailed "How to Use" example to include in your README.md file:

📝 How to Use

Method 1: Using the Command Palette

1. Open VS Code and navigate to a Git-tracked project.
2. Press Ctrl + Shift + P (Windows/Linux) or Cmd + Shift + P (Mac) to open the Command Palette.
3. Type "Lint Commit Message" and select it.
4. Enter your commit message in the input box.
5. The extension will validate the message and provide feedback:
   • ✅ If valid: A success message appears.
   • ⚠ If invalid: An error message appears with suggestions.
6. Choose an action:
   • "🔧 Fix to Conventional Commit format" – The extension will auto-correct the message.
   • "✅ Proceed Anyway" – Use the message without modifications.
7. If auto-fixed, the corrected message is copied to your clipboard for easy pasting into Git.

Method 2: Manual Validation with Error Insights

1. If you're unsure about your commit format, enter a message and let the extension validate it.
2. If errors exist, the extension will explain why (e.g., missing type, scope, or description).
3. You can manually adjust the message based on the feedback.

Example Usage

✅ Valid Commit Message Example:

feat(auth): add JWT authentication system

• Feedback: ✅ Commit message follows Conventional Commits!

❌ Invalid Commit Message Example:

added login feature

• Feedback: ⚠ Commit Issue: Missing valid commit type (e.g., feat, fix, chore).
• Fix Suggestion:

  feat(login): added login feature
  

📦 Installation Open VS Code Go to Extensions (Ctrl + Shift + X) Search for CommitIQ Click Install Alternatively, install via the VS Code Marketplace.

📝 Usage Open VS Code and navigate to your Git project. Run the "Lint Commit Message" command from the Command Palette (Ctrl + Shift + P). Enter a commit message when prompted. The extension will validate the message and display results. If needed, select "Auto-Fix" or "Proceed Anyway" based on the feedback. ⚙ Requirements VS Code (Latest Version Recommended) Git Installed on your system 🛠 Extension Settings This extension currently does not require configuration. Future updates may introduce customizable rules for commit validation.

🐞 Known Issues Some unconventional commit formats might not be auto-fixed perfectly. 📌 Release Notes 1.0.0 Initial release with commit validation and auto-fix suggestions.