Weave Code
Grumphp Laravel Pint Laravel Package
yieldstudio/grumphp-laravel-pint
A GrumPHP task that runs Laravel Pint on your changed PHP files, so every commit stays formatted to your chosen preset without slowing down your workflow.
yieldstudio/grumphp-laravel-pint integrates Laravel Pint into GrumPHP, letting you enforce Pint's code-style fixes automatically as part of your Git commit hooks. Instead of running Pint manually, this task hooks into GrumPHP's pipeline so style violations are caught and corrected before code ever reaches a commit.
- Adds a dedicated Pint task to GrumPHP's task runner
- Runs automatically on pre-commit and other configured hooks
- Supports Laravel Pint presets and custom configuration
- Blocks commits when style issues remain unfixed
- Simple, minimal setup via
grumphp.yml
Ideal for Laravel teams wanting consistent formatting with zero friction.
Frequently asked questions about Grumphp Laravel Pint
- What does yieldstudio/grumphp-laravel-pint do?
- It provides a GrumPHP task that runs Laravel Pint, Laravel's PHP code style fixer, as part of your GrumPHP checks. You can use it to enforce consistent formatting in Git hooks and CI so style issues are caught before code is merged. It is an integration package rather than a replacement for Pint itself.
- How do I install yieldstudio/grumphp-laravel-pint?
- Install it as a development dependency with Composer, typically using composer require --dev yieldstudio/grumphp-laravel-pint. You also need GrumPHP and Laravel Pint available in the project, usually as dev dependencies. After installation, register the task in your grumphp.yml and run GrumPHP to confirm it is detected.
- How do I configure the Laravel Pint task in grumphp.yml?
- Add the package's task to the tasks list in grumphp.yml and ensure it can find the Pint executable, commonly vendor/bin/pint in a Laravel project. Keep your style rules in pint.json so GrumPHP and manual Pint runs use the same configuration. Run GrumPHP after changing the task configuration to verify the arguments and paths are correct.
- Does this package support Laravel 10, 11, and 12?
- Compatibility is driven mainly by the versions of Laravel Pint, GrumPHP, and PHP that the package allows in its Composer constraints. Check the package's composer.json and release notes for the exact supported ranges before installing it in a Laravel 10, 11, or 12 project. Because it is a thin integration around Pint, it often works across Laravel versions when those underlying tools are compatible.
- Can I use this task in a Git pre-commit hook?
- Yes, that is a primary use case because GrumPHP is commonly configured to run on Git hooks. Add the Pint task to grumphp.yml and let GrumPHP's hook installation run it before commits, so non-compliant files block the commit. This catches style issues locally before they reach CI or code review.
- How do I run Laravel Pint style checks in CI with GrumPHP?
- Install dev dependencies in CI and run GrumPHP's check command as a pipeline step, with the Pint task enabled in grumphp.yml. Make the job fail on non-zero exit codes so style violations block the build. Caching Composer dependencies keeps the added CI time low.
- Does this task fix code style automatically or only report violations?
- Laravel Pint is capable of fixing style issues, but a GrumPHP task is usually configured as a check that fails when Pint reports violations. Whether files are modified depends on the Pint arguments and task options you configure. Many teams run Pint in fix mode locally and use the GrumPHP task as a non-mutating gate in hooks or CI.
- What are alternatives to using GrumPHP with Laravel Pint?
- You can run vendor/bin/pint directly in a Composer script, a Git hook manager such as CaptainHook or Husky, or a dedicated CI step without GrumPHP. GrumPHP is useful when you want multiple checks, including Pint, managed through one task runner and hook setup. This package makes sense if GrumPHP is already part of your workflow.
- How can I test that the GrumPHP Laravel Pint task is working?
- Trigger the relevant GrumPHP command or Git hook with a deliberately misformatted PHP file and confirm the task fails with Pint output. Then run it against a compliant file to confirm it passes. Checking both cases verifies the executable path, Pint configuration, and failure behavior.
- Is yieldstudio/grumphp-laravel-pint safe for production and actively maintained?
- It is a development tool, so it should be installed with --dev and used in local hooks and CI rather than in production runtime. Maintenance risk is relatively low because it integrates existing tools, but you should still review recent releases, open issues, and Composer constraints before adoption. Pin versions and test upgrades in CI to avoid surprises.
Weaver
How can I help you explore Laravel packages today?