Download the PHP package mubbi/laravel-commit-lint without Composer
On this page you can find all versions of the php package mubbi/laravel-commit-lint. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mubbi/laravel-commit-lint
More information about mubbi/laravel-commit-lint
Files in mubbi/laravel-commit-lint
Package laravel-commit-lint
Short Description It provides a Git hook to enforce Conventional Commits in Laravel projects.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-commit-lint
Laravel Commit Lint
Requirements
- Laravel >= 12.0
- PHP >= 8.2
Overview
Laravel Commit Lint helps teams enforce Conventional Commits in Laravel projects by automatically validating commit messages using a Git hook. This ensures consistent commit history and enables better automation and tooling.
Features
- Automatic commit message validation using a
commit-msghook - Customizable hook installation path via Artisan command
- Clear error messages and guidance for invalid commit messages
- Skips validation for merge, WIP, and revert commits
- Extensible via Laravel’s service provider and command structure
Installation
Usage
After installation, every commit will be checked for Conventional Commit compliance.
If your message does not match the required format, the commit will be rejected with guidance.
Example of valid commit messages
- feat: add user authentication
- fix: resolve issue with email validation
- docs: update API documentation
- refactor: improve query performance
- chore: update dependencies
- style: format code according to PSR-12
- test: add unit tests for login
Example of invalid commit messages
- updated stuff
- bug fix
- changes
- fixed it
- wip: working on something (WIP is skipped, but not recommended for final commits)
How it works
After installation, the package places a commit-msg hook in your .git/hooks directory (or a custom path if specified). This hook runs on every commit and checks your commit message against the Conventional Commits specification using a regex. If the message is invalid, the commit is rejected and guidance is shown.
The validation script automatically skips validation for merge, WIP, and revert commits.
Configuration
You can install the hook to a custom path:
You may also specify a custom stub file for the hook script:
Troubleshooting
Common Issues
- Hook not working: Ensure your repository has a
.git/hooksdirectory and that thecommit-msgfile is executable (chmod +x .git/hooks/commit-msg). - Artisan command not found: Make sure the package is installed as a dev dependency and your Laravel app's autoload files are up to date (
composer dump-autoload). - Commit rejected unexpectedly: Check your commit message format and ensure it matches the Conventional Commits spec. See valid examples above.
- Custom hook path not working: Verify the path exists and is writable.
If you encounter other issues, please open an issue on GitHub with details.
Uninstallation
To remove the commit lint hook, simply delete the commit-msg file from your .git/hooks directory:
To remove the package:
FAQ
Q: Does this work with all git clients? A: Yes, as long as your client supports git hooks.
Q: Can I customize the commit message rules? A: You can modify the stub or extend the validation logic in the package.
Q: Will this block merge commits? A: No, merge, WIP, and revert commits are skipped.
Contributing
Contributions are welcome! Please open issues or submit pull requests via GitHub. Follow Conventional Commits for your messages.
For questions and discussions, visit GitHub Discussions.
For more details, see the Contributing Guide.
License
This project is licensed under the MIT License.
Security
Please refer to our Security Policy for reporting vulnerabilities and security concerns.
