Skip to content

README.md

Latest commit

 

History

History
210 lines (160 loc) · 5.16 KB

README.md

File metadata and controls

210 lines (160 loc) · 5.16 KB

Commitrix 🎯

A powerful Git commit quality linter that enforces semantic commit conventions with intelligent suggestions and team collaboration features.

npm version CI License: MIT

✨ Features

  • 🔍 Semantic Commit Validation - Enforces conventional commit format
  • 🪝 Git Hook Integration - Automatic validation on commit
  • 🎨 Interactive Builder - Guided commit message creation
  • 💡 Smart Suggestions - Intelligent commit message fixes
  • 📊 Team Analytics - Repository commit statistics
  • ⚙️ Configurable Rules - Customize for your team
  • 🚀 CI/CD Ready - Validate commits in pipelines
  • 🔍 Commit Search - Find commits by message, type, or author

🚀 Quick Start

# Install globally
npm install -g commitrix

# Initialize in your project
commitrix init

# Install git hooks (auto-runs on npm install)
commitrix install

🎥 Demo

# ❌ Invalid commit gets rejected
$ git commit -m "fix bug"
❌ Commit message issues:
  • Must start with: feat, fix, docs, style, refactor, test, chore

💡 Suggested fix:
  fix: bug

# ✅ Valid commit passes
$ git commit -m "fix: resolve authentication timeout"
✅ Commit message looks good!

📖 Usage

# Lint a commit message
commitrix "feat: add user authentication"

# Interactive commit builder
commitrix build

# Get suggestions for invalid commits
commitrix suggest "fix bug"

# View repository statistics
commitrix stats

# Search commit messages
commitrix search "authentication"

# Search by type and author
commitrix search "bug" --type fix --author john

# Validate recent commits (CI/CD)
commitrix validate --count 10

⚙️ Configuration

Create .commitrix.json in your project root:

{
  "types": ["feat", "fix", "docs", "style", "refactor", "test", "chore"],
  "maxLength": 72,
  "minLength": 10,
  "scopes": ["api", "ui", "docs"],
  "enforceScope": false
}

🔧 Commands

Command Description
commitrix <message> Lint commit message
commitrix build Interactive commit builder
commitrix install Install git hooks
commitrix init Initialize project
commitrix stats Show commit statistics
commitrix suggest <message> Get suggestions
commitrix validate Validate recent commits
commitrix check Check project setup
commitrix config [key] [value] Show/set configuration
commitrix template --type <type> Generate commit template
commitrix history --count <n> Analyze commit history
commitrix help Show help information
commitrix lint <message> Lint specific message
commitrix fix <message> Auto-fix commit message
commitrix reset Reset config to defaults
commitrix doctor Run health check on setup
commitrix scan --count <n> Scan repository for issues
commitrix benchmark Run performance benchmark
commitrix report --format <fmt> Generate quality report
commitrix search <query> Search commit messages

📋 Examples

Health Check

$ commitrix doctor
🩺 Running Commitrix Health Check...
✅ Git repository detected
✅ Configuration file found
✅ Git hook installed
🎉 Health check complete: 0 issue(s) found

Repository Scan

$ commitrix scan --count 20
🔍 Scanning last 20 commits...
📊 Scan Results:
✅ Valid commits: 18
❌ Invalid commits: 2
📈 Quality score: 90%

Performance Benchmark

$ commitrix benchmark
⚡ Running Commitrix Performance Benchmark...
📊 Benchmark Results:
🚀 Average per lint: 0.085ms
📈 Throughput: 11,811 lints/second

Commit Search

$ commitrix search "auth"
🔍 Found 3 matching commits:

a1b2c3d [feat] feat: add user authentication
e4f5g6h [fix] fix: resolve auth token expiry
i7j8k9l [docs] docs: update auth documentation

📊 Search completed: 3 results

$ commitrix search "bug" --type fix --count 10
🔍 Found 2 matching commits:

x1y2z3a [fix] fix: resolve login bug
b4c5d6e [fix] fix: fix memory leak bug

📊 Search completed: 2 results

Quality Report

$ commitrix report
📊 Commit Quality Report
📈 Quality Score: 96%
✅ Valid: 26 | ❌ Invalid: 1
👥 Authors: 2
🏷️ Top Types: chore(5), fix(6), feat(8)

🏗️ CI/CD Integration

Add to your GitHub Actions workflow:

- name: Validate Commits
  run: npx commitrix validate --count 10

🛠️ Development

# Clone repository
git clone https://github.com/zmelliti/commitrix.git
cd commitrix

# Install dependencies
npm install

# Run tests
npm test

# Test locally
node src/index.js "feat: test message"

🤝 Contributing

Contributions are welcome! Please read CONTRIBUTING.md for guidelines.

📝 License

MIT © ZMelliti

Made with ❤️ for the community by Zied MELLITI