Laravel Pint
Introduction
Laravel Pint is an opinionated PHP code style fixer for minimalists. Pint is built on top of PHP-CS-Fixer and makes it simple to ensure that your code style stays clean and consistent.
Pint is automatically installed with all new Laravel applications so you may start using it immediately. By default, Pint does not require any configuration and will fix code style issues in your code by following the opinionated coding style of Laravel.
Installation
Pint is included in recent releases of the Laravel framework, so installation is typically unnecessary. However, for older applications, you may install Laravel Pint via Composer:
composer require laravel/pint --dev
Running Pint
You can instruct Pint to fix code style issues by invoking the pint
binary that is available in your project's vendor/bin
directory:
./vendor/bin/pint
You may also run Pint on specific files or directories:
./vendor/bin/pint app/Models ./vendor/bin/pint app/Models/User.php
Pint will display a thorough list of all of the files that it updates. You can view even more detail about Pint's changes by providing the -v
option when invoking Pint:
./vendor/bin/pint -v
If you would like Pint to simply inspect your code for style errors without actually changing the files, you may use the --test
option. Pint will return a non-zero exit code if any code style errors are found:
./vendor/bin/pint --test
If you would like Pint to only modify the files that have uncommitted changes according to Git, you may use the --dirty
option:
./vendor/bin/pint --dirty
If you would like Pint to fix any files with code style errors but also exit with a non-zero exit code if any errors were fixed, you may use the --repair
option:
./vendor/bin/pint --repair
Configuring Pint
As previously mentioned, Pint does not require any configuration. However, if you wish to customize the presets, rules, or inspected folders, you may do so by creating a pint.json
file in your project's root directory:
{ "preset": "laravel"}
In addition, if you wish to use a pint.json
from a specific directory, you may provide the --config
option when invoking Pint:
./vendor/bin/pint --config vendor/my-company/coding-style/pint.json
Presets
Presets define a set of rules that can be used to fix code style issues in your code. By default, Pint uses the laravel
preset, which fixes issues by following the opinionated coding style of Laravel. However, you may specify a different preset by providing the --preset
option to Pint:
./vendor/bin/pint --preset psr12
If you wish, you may also set the preset in your project's pint.json
file:
{ "preset": "psr12"}
Pint's currently supported presets are: laravel
, per
, psr12
, symfony
, and empty
.
Rules
Rules are style guidelines that Pint will use to fix code style issues in your code. As mentioned above, presets are predefined groups of rules that should be perfect for most PHP projects, so you typically will not need to worry about the individual rules they contain.
However, if you wish, you may enable or disable specific rules in your pint.json
file or use the empty
preset and define the rules from scratch:
{ "preset": "laravel", "rules": { "simplified_null_return": true, "braces": false, "new_with_braces": { "anonymous_class": false, "named_class": false } }}
Pint is built on top of PHP-CS-Fixer. Therefore, you may use any of its rules to fix code style issues in your project: PHP-CS-Fixer Configurator.
Excluding Files / Folders
By default, Pint will inspect all .php
files in your project except those in the vendor
directory. If you wish to exclude more folders, you may do so using the exclude
configuration option:
{ "exclude": [ "my-specific/folder" ]}
If you wish to exclude all files that contain a given name pattern, you may do so using the notName
configuration option:
{ "notName": [ "*-my-file.php" ]}
If you would like to exclude a file by providing an exact path to the file, you may do so using the notPath
configuration option:
{ "notPath": [ "path/to/excluded-file.php" ]}
Continuous Integration
GitHub Actions
To automate linting your project with Laravel Pint, you can configure GitHub Actions to run Pint whenever new code is pushed to GitHub. First, be sure to grant "Read and write permissions" to workflows within GitHub at Settings > Actions > General > Workflow permissions. Then, create a .github/workflows/lint.yml
file with the following content:
name: Fix Code Style on: [push] jobs: lint: runs-on: ubuntu-latest strategy: fail-fast: true matrix: php: [8.3] steps: - name: Checkout code uses: actions/checkout@v4 - name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: ${{ matrix.php }} extensions: json, dom, curl, libxml, mbstring coverage: none - name: Install Pint run: composer global require laravel/pint - name: Run Pint run: pint - name: Commit linted files uses: stefanzweifel/git-auto-commit-action@v5 with: commit_message: "Fixes coding style"