Download the PHP package choerulumam/commitlint-php without Composer

CommitLint PHP 🎯

A powerful Git hooks and commit message linting tool for PHP projects - combining the best of husky and commitlint in a native PHP implementation.

🚀 Features

• 🎯 Commit Message Validation - Enforce conventional commit format with customizable rules
• 🪝 Git Hooks Management - Easy installation and management of Git hooks
• ⚙️ Flexible Configuration - Configure via .commitlintrc.json or composer.json
• 🔧 Developer Friendly - Beautiful CLI output with helpful error messages
• 📦 Minimal Dependencies - Only requires Symfony Console component
• 🧪 Fully Tested - Comprehensive test suite with PHPUnit
• 🎨 PHP 7.3+ Compatible - Works with PHP 7.3 through PHP 8.3
• 🔒 Security First - Built-in security features and input validation

Requirements

• PHP >= 7.3
• Composer
• Git

📦 Installation

Install via Composer:

🔧 Quick Start

1. Install Git Hooks

2. Start Making Commits!

📋 Commands

Install Hooks

Install Git hooks and create default configuration:

Options:

• --force, -f - Force installation even if hooks already exist
• --skip-config - Skip creating default configuration file

Validate Commit Message

Validate commit messages against your configuration:

Options:

• --file, -f - Read commit message from specific file
• --quiet, -q - Suppress output (exit code only)

Show Status

Display installed hooks and configuration:

Uninstall

Remove all installed Git hooks:

⚙️ Configuration

CommitLint PHP can be configured via .commitlintrc.json file or within your composer.json. The tool automatically merges your custom configuration with sensible defaults.

Configuration File Priority

1. .commitlintrc.json in your project root
2. extra.commitlint-php in composer.json
3. Default configuration

Complete Configuration Reference

Configuration Options

Type Rules (rules.type)

• required (boolean, default: true) - Whether commit type is required
• allowed (array, default: see above) - Array of allowed commit types

Scope Rules (rules.scope)

• required (boolean, default: false) - Whether commit scope is required
• allowed (array, default: []) - Array of allowed scopes (empty = any scope allowed)

Subject Rules (rules.subject)

• min_length (int, default: 1) - Minimum subject length
• max_length (int, default: 100) - Maximum subject length
• case (string, default: "any") - Case requirement: "lower", "upper", or "any"
• end_with_period (boolean, default: false) - Whether subject must end with period

Body Rules (rules.body)

• max_line_length (int, default: 100) - Maximum line length for body (0 = no limit)
• leading_blank (boolean, default: true) - Require blank line between subject and body

Footer Rules (rules.footer)

• leading_blank (boolean, default: true) - Require blank line between body and footer

Hook Configuration (hooks)

Control which Git hooks are installed:

📖 Example Configurations

Minimal Configuration

Strict Configuration

Configuration in composer.json

📝 Commit Message Format

This package enforces the Conventional Commits specification:

Examples

Default Commit Types

• feat - New features
• fix - Bug fixes
• docs - Documentation changes
• style - Code style changes (formatting, etc)
• refactor - Code refactoring
• perf - Performance improvements
• test - Adding or updating tests
• chore - Maintenance tasks
• ci - CI/CD changes
• build - Build system changes
• revert - Reverting previous commits

Special Commit Types (Auto-Skip Validation)

The following commit types automatically skip validation:

• Merge commits - Merge branch "feature" into main
• Revert commits - Revert "feat: add user authentication"
• Initial commits - Initial commit
• Fixup commits - fixup! feat: add user authentication

🛠️ Development

Running Tests

🤝 Contributing

Contributions are welcome! Please read our Contributing Guide for details.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Inspired by husky and commitlint
• Inspired by dev-kraken/php-commitlint
• Built with Symfony Console

Author

chumam2050 - [email protected]