Weave Code
Pint Laravel Package
laravel/pint
Laravel Pint is an opinionated PHP code style fixer for minimalists. Built on PHP-CS-Fixer, it makes it easy to keep your Laravel and PHP projects clean and consistent with a simple, standardized formatting workflow.
An opinionated code formatter for PHP.
Frequently asked questions about Pint
- How do I install Laravel Pint in my Laravel project?
- Run `composer require laravel/pint --dev` to install Pint as a development dependency. After installation, generate a default configuration with `php artisan pint:install`. Pint will automatically create a `.pint.php` file in your project root.
- Does Laravel Pint work with non-Laravel PHP projects?
- Yes, Pint can be used outside Laravel by running `./vendor/bin/pint` directly. However, it defaults to Laravel’s opinionated preset, so you’ll need to customize the rules in `.pint.php` if you’re not using Laravel’s style guide.
- What PHP versions does Laravel Pint support?
- Pint requires PHP 8.1 or higher. As of v1.26.0, it supports PHP 8.1 through 8.5. Check the [Laravel Pint docs](https://laravel.com/docs/pint) for the latest compatibility details before upgrading.
- Can I customize Pint’s rules beyond the Laravel preset?
- Absolutely. Extend the Laravel preset in your `.pint.php` file using `extends: laravel`, then override specific rules under the `rules` key. For example, to disable a rule, add `'no_unused_imports' => false` to your config.
- How do I integrate Pint into my CI/CD pipeline?
- Use Pint’s `--test` flag to fail builds on style violations. Example GitHub Actions step: `php artisan pint --test`. For incremental checks, use `--diff` to compare against Git’s staging area. Always run Pint in CI to enforce consistency.
- Will Pint break my existing PHP-CS-Fixer configuration?
- Pint is designed to replace PHP-CS-Fixer seamlessly. If you have a `.php-cs-fixer.dist.php` file, Pint can inherit its rules by adding `extends: laravel` and merging custom rules. Run `php artisan pint --diff` to spot conflicts before full adoption.
- How does Pint handle large codebases with inconsistent formatting?
- Start with `--diff` to identify discrepancies incrementally. For massive refactors, use `--parallel` to speed up processing, but monitor CI resource usage. Consider running Pint in pre-commit hooks (e.g., with Laravel Pint + Git Hooks) to catch issues early.
- Can I use Pint alongside IDE plugins like PHP-CS-Fixer for VSCode?
- Pint is CLI-first, so IDE plugins may not recognize it automatically. Configure your IDE to use Pint’s binary (`./vendor/bin/pint`) for formatting. For real-time feedback, use the `--diff` flag with IDE integrations that support external tools.
- What’s the difference between Pint’s `--test` and `--diff` modes?
- `--test` checks all files and fails the build if violations are found, ideal for CI/CD. `--diff` compares staged Git changes against Pint’s rules, perfect for pre-commit hooks. Use `--test` in CI and `--diff` locally to catch issues before they’re committed.
- Are there alternatives to Laravel Pint for PHP code formatting?
- Yes, the primary alternative is PHP-CS-Fixer itself, which Pint is built upon. Other tools like Prettier (via plugins) or custom PHPCBF scripts exist, but Pint offers a Laravel-optimized, minimalist workflow without requiring deep configuration. Evaluate based on your team’s need for opinionated vs. customizable rules.
Weaver
How can I help you explore Laravel packages today?